Checks API readiness

GET 
/readyz

Checks API readiness

Request

Responses

200

API is ready

application/json

Schema

Schema

healthybooleanrequired
unreadystring[]

Example (from schema)

{
  "healthy": true,
  "unready": [
    "string"
  ]
}

500

A generic API error containing the cause of the error

application/json

Schema

Schema

codeint32required
detailstringrequired
messagestringrequired
uristringrequired
verbstringrequired

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

503

API has unready componenets

application/json

Schema

Schema

healthybooleanrequired
unreadystring[]

Example (from schema)

{
  "healthy": true,
  "unready": [
    "string"
  ]
}