API reference

API reference: Health

Cushy's public health probe: a simple liveness check your monitoring can poll — ok true when the service and its database are up.

A public liveness probe for your monitoring. It requires no authentication and exposes no sensitive detail.

GET/api/healthPublic

Report liveness: ok: true when the service and its database are reachable. The response may carry additional operational fields; treat anything beyond ok as informational.

Example response

json

// healthy:
{ "ok": true, "…": "…" }

// database down:
{ "ok": false, "errorCode": "…", "hint": "…" }

Errors

Status	When
`503`	The service cannot reach its database — carries a short errorCode and a hint.