Skip to content

Health API Reference ​

GET /healthz ​

Check liveness

Use this inexpensive unauthenticated probe to determine whether the HTTP process is alive. Load balancers and orchestrators call it without credentials.

Responses ​

  • 200 — Successful response
json
{
  "status": "ok"
}

GET /readyz ​

Check readiness

Use this unauthenticated probe before routing traffic. It checks database readiness and returns not_ready while dependencies are unavailable.

Responses ​

  • 200 — Successful response
json
{
  "status": "ready"
}

Errors ​

StatusCodeDetail
503not_readyService Unavailable