v1

latestOpenAPI 3.1.02026-07-17223.8 KB
Health

Root health check

Returns the health status of the API and its dependencies

get/

Response

All services are healthy

okboolean required

Overall health status - true if all checks pass

servicestring required

Name of the service

Example response

{
  "service": "refref-api",
  "checks": {
    "api": {
      "error": "connection timeout"
    },
    "database": {
      "error": "connection timeout"
    }
  }
}
All 2 operations