Health
Liveness plus the pipeline check that alarms when readings arrive and nothing alerts, or alerts queue and nothing is delivered.
| Operation | Endpoint |
|---|---|
| Liveness | GET /api/health |
GET /api/health
/api/healthLiveness
Unauthenticated, always 200: the HTTP status reports that the process is serving, not that its dependencies are well, because this route gates container liveness. healthy is false while the database does not answer (db.ok); page on it.
No authentication.
Responses
| Status | Meaning |
|---|---|
200 | The service is up; db reports database reachability, version and commit the running build. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
healthy | boolean | yes | False while the database does not answer, as db.ok; the status stays 200. Example: true. |
db | unknown | yes | Database reachability; ok is false on a stall. |
version | string | null | yes | The running release: the one the deploy workflow stamped, else <next>-dev+<commit>; null when neither is known. Example: "1.2.0-rc.3". |
commit | string | null | yes | The commit the running build was made from; null when unknown. Example: "a1b2c3d". |
Updated 26 days ago
Did this page help you?