Get Gateway Readiness

Reports readiness after local initialization and becomes not_ready immediately when process shutdown starts. Returns HTTP 503 during startup or shutdown, with the ReadinessStatus JSON body rather than Problem Details. Shared dependency outages remain diagnostic and do not remove every Gateway replica from service. Compatibility and liveness probes remain available during shutdown.

Header Parameters

X-Request-ID?string

Optional caller correlation metadata. Gateway creates a new authoritative request ID, returns it in the response X-Request-ID header and Problem Details requestId, and propagates that generated value to its dependencies.

Match^[A-Za-z0-9][A-Za-z0-9._:-]*$

Length1 <= length <= 128

Response Body

`application/json`

`application/problem+json`

curl -X GET "https://example.com/health/ready" \  -H "X-Request-ID: erp-run-20260916-0042"

{
  "status": "ready",
  "checks": {
    "initialized": true,
    "redis": true
  }
}

{
  "status": "ready",
  "checks": {
    "initialized": true,
    "redis": true
  }
}

{
  "type": "http://example.com",
  "title": "string",
  "status": 400,
  "detail": "string",
  "instance": "http://example.com",
  "code": "GW_REQUEST_INVALID_JSON",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "timestamp": "2019-08-24T14:15:22Z",
  "action": {
    "code": "string",
    "description": "string",
    "documentation": "http://example.com"
  },
  "retry": {
    "strategy": "DO_NOT_RETRY",
    "sameIdempotencyKey": true,
    "afterSeconds": 0
  },
  "errors": [
    {
      "location": "header",
      "field": "string",
      "pointer": "string",
      "code": "REQUIRED",
      "detail": "string"
    }
  ],
  "operationId": "string",
  "message": "string",
  "statusCode": 0,
  "path": "string"
}

{
  "type": "http://example.com",
  "title": "string",
  "status": 400,
  "detail": "string",
  "instance": "http://example.com",
  "code": "GW_REQUEST_INVALID_JSON",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "timestamp": "2019-08-24T14:15:22Z",
  "action": {
    "code": "string",
    "description": "string",
    "documentation": "http://example.com"
  },
  "retry": {
    "strategy": "DO_NOT_RETRY",
    "sameIdempotencyKey": true,
    "afterSeconds": 0
  },
  "errors": [
    {
      "location": "header",
      "field": "string",
      "pointer": "string",
      "code": "REQUIRED",
      "detail": "string"
    }
  ],
  "operationId": "string",
  "message": "string",
  "statusCode": 0,
  "path": "string"
}

Get Gateway Readiness

Header Parameters

Response Body

200application/json

503application/json

508application/problem+json

defaultapplication/problem+json

`application/json`

`application/json`

`application/problem+json`

`application/problem+json`