Skip to main content
GET
/
health
/
readiness
Readiness probe
curl --request GET \
  --url https://api.example.com/health/readiness \
  --header 'Authorization: Bearer <token>'
{
  "healthy": true,
  "checks": [
    {
      "name": "<string>",
      "passed": true,
      "details": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication. Format: 'Bearer '

Response

200 - application/json

Successful Response

healthy
boolean
required
checks
CheckResult · object[]
required