Sign in
🔍 Observability

Check the health of the server

Perform all health checks and return the server's health status.

get/health

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/health
  • Auth: API key in header X-Api-Key

Response

The Health Check is successful

statusstring
infoobject nullable
errorobject nullable
detailsobject

Example response

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.