Sign in
latestOpenAPI 3.0.02026-08-138371125.7 KB

707a88e0b355

System

Check the API health

This endpoint reports the API and its dependencies health.

get/v1/_health

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"
    }
  }
}