API and OpenAPI

Parix exposes the external integration API under /api/v1. The OpenAPI document is generated from the Hono route registry:

/api/v1/openapi.json

The docs API reference is available at:

/docs/openapi

Use this page as a reference for the public integration boundary. Use the generated OpenAPI page for exact schemas.

The generated OpenAPI document defines local, development, staging, and production server entries.

Authentication

Use either:

• x-api-key: <key>
• Authorization: Bearer <token-or-api-key>

API key metadata determines organization access, optional database scope, and read/write permissions. Missing authentication returns an authentication error. A valid credential without the required scope returns an authorization error.

Database lifecycle endpoints

The API registry includes:

• GET /api/v1/catalog/create
• POST /api/v1/databases
• GET /api/v1/databases
• GET /api/v1/databases/{databaseId}
• DELETE /api/v1/databases/{databaseId}
• GET /api/v1/session
• POST /api/v1/databases/{databaseId}/tb/{operation}

Use the catalog endpoint before create flows when you need the current provider, region, topology, cluster size, storage tier, and storage capability IDs.

Response model

Route handlers use structured response schemas and problem details. Database create responses can include billing data, database data, profile data, provisioning job data, and a provisioning status message.