Health

Liveness probe

get

Responses

200

The Health Check is successful

application/json

statusstringOptionalExample: ok

503

The Health Check is not successful

application/json

get/health/liveness

GET /health/liveness HTTP/1.1
Accept: */*

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

Readiness probe (checks DB)

get

Responses

200

The Health Check is successful

application/json

statusstringOptionalExample: ok

503

The Health Check is not successful

application/json

get/health/readiness

GET /health/readiness HTTP/1.1
Accept: */*

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