Projects

Gets project's service health status

get/v1/projects/{ref}/health

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • fga_permissions (a scheme the document does not define)

Path parameters

refstring required

Project ref

Query parameters

servicesstring[] required
timeout_msinteger

Response

name'auth' | 'db' | 'db_postgres_user' | 'pooler' | 'realtime' | 'rest' | 'storage' | 'pg_bouncer' required
healthyboolean required

Deprecated. Use status instead.

status'COMING_UP' | 'ACTIVE_HEALTHY' | 'UNHEALTHY' required
errorstring

Changes

No recorded changes to this operation across all 1 revision of this API.