Skip to main content
GET /readyz Readiness probe endpoint. No authentication required. Checks database connectivity in addition to process health. Returns 503 if the database is unreachable. Used by load balancers and orchestrators to determine whether the service should receive traffic.

Response

200 — Service is ready
status
string
required
ok when the service is ready.
db
string
required
connected when the database is reachable.
503 — Service not ready
status
string
required
error when the service cannot accept traffic.
db
string
required
unavailable when the database cannot be reached.

Examples

curl http://localhost:8080/readyz
{
  "status": "ok",
  "db": "connected"
}

Build docs developers (and LLMs) love