Operational

Get instance readiness status

This operation returns information about whether this Unleash instance is ready to serve requests or not. Typically used by your deployment orchestrator (e.g. Kubernetes, Docker Swarm, Mesos, et al.).

get/ready

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/ready
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Response

readyCheckSchema

health'GOOD' required

The readiness state this Unleash instance is in. GOOD if the server is up and running. If the server is unhealthy you will get an unsuccessful http response.

Example response

{
  "health": "GOOD"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.