Tone docs
API referenceHealth

Readiness — are dependencies reachable?

Checks Postgres. Answers 503 when a dependency is down, which is the signal to stop sending this instance traffic without restarting it. Cache status rides along in the payload but never fails the probe — it is an optimisation, not a dependency. Queue depths ride along the same way: the API only ever produces, so a broker outage defers work rather than breaking a request. The process that cannot run without a broker is tone-worker, which refuses to boot instead of reporting here.

GET
/health/ready

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/health/ready"
{  "details": {    "database": {      "status": "up"    }  },  "error": {},  "info": {    "database": {      "status": "up"    }  },  "status": "ok"}
Was this page helpful?