Skip to main content

Get instance operational status

GET 

<your-unleash-url>/health

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.).

Responses

healthCheckSchema

Schema
    healthstringrequired

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

    Possible values: [GOOD, BAD]

    Example: GOOD

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
curl -L '<your-unleash-url>/health' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'
Request Collapse all
Base URL
<your-unleash-url>
Auth
ResponseClear

Click the Send API Request button above and see the response here!