Browse this guideSite health endpoint
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

CodeMeaning
200Successful Response
503Service Unavailable

Response body

FieldValuesMeaning
status`okerror`
checks.db`okerror`
checks.deposit_auth`okerror`

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.