Technical referenceUpdated 2026-11-08
Site health endpoint
Use GET /health to check the Site ingress process, database connectivity, and the outcome of the Deposit token provider's last Auth attempt. The endpoint returns 503 when either check is error.
deposit_auth reports the last attempt, not whether the current access token is still fresh. While that result is ok, a health request does not call Auth. While it is error, the process makes at most one recovery attempt per minute; concurrent health requests during that attempt return error immediately.
Request
GET /health
No request body is required.
Responses
| Code | Meaning |
|---|---|
200 | Successful Response |
503 | Service Unavailable |
Response body
| Field | Values | Meaning |
|---|---|---|
status | `ok | error` |
checks.db | `ok | error` |
checks.deposit_auth | `ok | error` |
200 example:
{
"status": "ok",
"checks": {
"db": "ok",
"deposit_auth": "ok"
}
}
503 example:
{
"status": "error",
"checks": {
"db": "ok",
"deposit_auth": "error"
}
}
This page is generated from the Site ingress OpenAPI schema. Do not edit it by hand.