API
Postgres API
REST API endpoints for provisioning and managing PostgreSQL databases.
Endpoints for managing Postgres database services within your organization.
List services
GET /api/orgs/:orgSlug/projects/:projectSlug/postgres/servicesReturns all Postgres services in a project.
Create a service
POST /api/orgs/:orgSlug/projects/:projectSlug/postgres/servicesProvisions a new Postgres database.
| Field | Type | Required | Description |
|---|---|---|---|
displayName | string | yes | Human-readable name |
plan | string | yes | Plan type (trial, starter, launch, growth, business) |
Returns 202 Accepted with the service ID and status: "provisioning".
Get a service
GET /api/orgs/:orgSlug/projects/:projectSlug/postgres/services/:serviceIdReturns service details including status, plan, region, and timestamps.
Get credentials
GET /api/orgs/:orgSlug/projects/:projectSlug/postgres/services/:serviceId/credentialsReturns the connection string. Credentials are returned masked by default.
Delete a service
DELETE /api/orgs/:orgSlug/projects/:projectSlug/postgres/services/:serviceIdTriggers async deletion. Returns 202 Accepted.
Need help? Contact support.