Status Endpoint
Cadenza exposes a status endpoint that can (and should) be used to monitor the fundamental health of the
Cadenza instance. It is available under the /cadenza/status URL and returns a plain text response
that depends on the state of the cluster. We also use this endpoint ourselves to verify the state
of Cadenza when it gets started in our Docker container or Kubernetes deployments.
Possible Responses
A HTTP GET request to /cadenza/status will receive one of the following possible responses. All response bodies are sent using the text/plain content type.
| HTTP Status Code | Response Body | Explanation |
|---|---|---|
503 (UNAVAILABLE) |
|
Cadenza is still starting and not ready for requests yet. |
503 (UNAVAILABLE) |
|
Some error has occurred and Cadenza is no longer in a good state and should not get new requests sent to it. This can happen when a Cadenza node is part of a network segmentation event and finds itself in the minority part of a cluster. |
200 (OK) |
|
Cadenza is started and ready to serve requests. |