Technical referenceUpdated 2026-09-14

Site health endpoint

Available

Use GET /health to check the Site ingress process and the backing services represented in its response. The endpoint currently reports database connectivity; its checks object can grow as more Site entrypoints are added.

Request

GET /health

No request body is required.

Responses

CodeMeaning
200Successful Response
503Service Unavailable

Response body

FieldValuesMeaning
status`okerror`
checks.db`okerror`

200 example:

{
  "status": "ok",
  "checks": {
    "db": "ok"
  }
}

503 example:

{
  "status": "error",
  "checks": {
    "db": "error"
  }
}

This page is generated from the Site ingress OpenAPI schema. Do not edit it by hand.