Health

Health Check

Check API and database health (DEEP — touches the DB).

Returns HTTP 200 only when the database is reachable. A degraded backend (db_manager.check_health() returns False) surfaces as HTTP 503 with the same response body so uptime monitors, load balancers, and Kubernetes probes can act on the status code — the previous behavior returned 200 with status="degraded" and was treated as healthy by every standard probe.

For a process-liveness signal that does NOT depend on the DB (e.g. the systemd ExecStartPost gate), use /api/health/live instead.

get/api/health

Request

  • Base URL: https://api.zerogex.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.zerogex.io/api/health
  • Auth: HTTP bearer

Response

Successful Response

statusstring required

healthy, degraded, or unhealthy

database_connectedboolean required
last_data_updatestring date-time nullable
data_age_secondsinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.