Health Checks

Readiness Health Check.

Changed on

Checks the application readiness. This is used to know when the service is ready to take request, based on its dependencies.

get/healthz/ready

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Response

Healthy

statusstring
totalDurationstring
entriesobject

Example response

{
  "status": "Healthy",
  "totalDuration": "00:00:01.7586185",
  "entries": {
    "Url-External Service": {
      "data": {},
      "duration": "00:00:00.2625794",
      "status": "Healthy",
      "tags": [
        "ready"
      ]
    },
    "SqlServer-Default": {
      "data": {},
      "duration": "00:00:01.7575155",
      "status": "Healthy",
      "tags": [
        "ready"
      ]
    },
    "Redis-Default": {
      "data": {},
      "duration": "00:00:00.2679798",
      "status": "Healthy",
      "tags": [
        "ready"
      ]
    }
  }
}

Changes