Technical referenceUpdated 2026-09-14
Site health endpoint
AvailableUse 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
| Code | Meaning |
|---|---|
200 | Successful Response |
503 | Service Unavailable |
Response body
| Field | Values | Meaning |
|---|---|---|
status | `ok | error` |
checks.db | `ok | error` |
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.