Get instance operational status

GET <your-unleash-url>/health

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

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

Request

Responses

• 200
• 500

---

healthCheckSchema

application/json

Schema

Schema

• health string required

  Possible values: [GOOD, BAD]

  The state this Unleash instance is in. GOOD if everything is ok, BAD if the instance should be restarted

Example (from schema)

{
  "health": "GOOD"
}

healthCheckSchema

application/json

Schema

Schema

• health string required

  Possible values: [GOOD, BAD]

  The state this Unleash instance is in. GOOD if everything is ok, BAD if the instance should be restarted

Example (from schema)

{
  "health": "GOOD"
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

curl / cURL

curl -L -X GET '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / native

curl -L -X GET '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / httpclient

curl -L -X GET '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'