Get liveness flag
GET/alive
Returns a single machine-readable flag summarising the outcome of a health check run over the API's runtime dependencies (currently, the Besu ledger node), intended for external uptime monitoring.
Responds 200 with { "health_global": 1 } if every dependency is healthy, 503 with
{ "health_global": 0 } otherwise. The result is cached for up to 5 minutes, so a change in
dependency health can take up to 5 minutes to be reflected here.
Responses
- 200
- 405
- 406
- 503
Success -- every runtime dependency is healthy.
Method Not Allowed. Returned for any documented path invoked with an HTTP method it doesn't support.
Response Headers
Comma-separated list of HTTP methods supported by this path.
GET, HEADNot Acceptable. Returned when the request's Accept header matches none of the content
types this operation can produce.
Service Unavailable -- at least one runtime dependency is unhealthy.