Skip to Content

Databases API

API for managing Databases resources.

Fields

interface Databases { name: string; domain: string; type: 'Integrated' | 'Dedicated' | 'Self-Hosted'; schemaEnforcement: 'flexible' | 'enforced'; databaseType?: 'Mongo' | 'Postgres' | 'Sqlite'; regions?: 'us-east-1' | 'us-east-2' | 'us-west-1' | 'us-west-2' | 'eu-west-1' | 'ap-northeast-1' | 'ap-southeast-1' | 'eu-central-1' | 'ap-south-1'; nouns?: string[]; }

API Endpoints

GET /api/databases

Retrieves a list of Databases with pagination.

Query Parameters

  • limit: Maximum number of items to return (default: 10)
  • page: Page number for pagination (default: 1)
  • sort: Field to sort by (default: createdAt)
  • where: JSON query for filtering results

GET /api/databases/:id

Retrieves a single Databases by ID.

POST /api/databases

Creates a new Databases.

PATCH /api/databases/:id

Updates an existing Databases.

DELETE /api/databases/:id

Deletes a Databases.

Last updated on