Skip to content

Health API Reference ​

GET /healthz ​

Check liveness

Use this unauthenticated probe to decide whether the HTTP process is alive. It never touches PostgreSQL or webcam-server, so it keeps answering ok during an upstream outage and is safe to call on a short interval.

Responses ​

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

GET /readyz ​

Check readiness

Use this unauthenticated probe on the operator dashboard. It pings PostgreSQL and calls webcam-server's /readyz with a 5-second timeout; both must answer, otherwise the probe reports 503 with detail upstream_unavailable and names the unreachable dependencies in the reason member.

Responses ​

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

Errors ​

StatusCodeDetail
503upstream_unavailableService Unavailable