v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Projects

Gets project's service health status

get/v1/projects/{ref}/health

Path parameters

refstring required
Example:abcdefghijklmnopqrst

Project ref

Query parameters

servicesstring[] required
[
  "auth",
  "rest"
]
timeout_msinteger
Example:2000

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