Health

These endpoints are intended for load balancers, Kubernetes probes, and operational checks.

GET /health

Basic liveness probe.

curl "$API_BASE_URL/health"

Response 200 OK:

{
  "status": "ok"
}

GET /healthz

Alias for the liveness probe.

curl "$API_BASE_URL/healthz"

Response 200 OK:

{
  "status": "ok"
}

GET /readyz

Readiness probe. This endpoint performs a MongoDB ping before reporting success.

curl "$API_BASE_URL/readyz"

Success response 200 OK:

{
  "status": "ok"
}

Example failure 503 Service Unavailable:

{
  "type": "about:blank",
  "title": "MongoDB ping failed",
  "status": 503,
  "detail": "A timeout occurred after waiting 2000ms."
}