Health

Liveness plus the pipeline check that alarms when readings arrive and nothing alerts, or alerts queue and nothing is delivered.

OperationEndpoint
LivenessGET /api/health

GET /api/health

Liveness

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

StatusMeaning
200The service is up; db reports database reachability, version and commit the running build.

Response body

FieldTypeRequiredDescription
healthybooleanyesFalse while the database does not answer, as db.ok; the status stays 200. Example: true.
dbunknownyesDatabase reachability; ok is false on a stall.
versionstring | nullyesThe running release: the one the deploy workflow stamped, else <next>-dev+<commit>; null when neither is known. Example: "1.2.0-rc.3".
commitstring | nullyesThe commit the running build was made from; null when unknown. Example: "a1b2c3d".

Did this page help you?