Sign in
Postgres

Get an environment's managed Postgres database

Returns the managed Postgres cluster linked to the environment, or 404 when no database has been activated. Requires the database feature flag.

get/projects/{id}/environments/{envId}/postgres

Request

  • Base URL: /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/projects/{id}/environments/{envId}/postgres
  • Auth: HTTP bearer

Path parameters

idstring required

The project ID (UUID).

envIdstring required

The environment ID (UUID).

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required

When the database was activated.

idstring required

The managed Postgres database ID.

proxy_hostnamestring

The customer-facing Postgres proxy hostname.

statusstring required

Derived cluster health: provisioning, healthy, or degraded.

Example response

{
  "$schema": "/v1/schemas/PostgresDatabaseResponse.json"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.