TXtxpipe
Health

Get Health

Retrieve Kupo's application health status. Note that this call is cheap and does not halt the various concurrent tasks performed by the Kupo.

This endpoint has two possible content-types: application/json or text/plain. The latter returns health in a format suitable for Prometheus. The server defaults to application/json, but you can control this behavior by passing a corresponding Accept header.

In addition, the server may return any of the following response codes:

  • 200: when healthy
  • 202: when connected to a chain producer but still syncing
  • 503: when disconnected from a chain producer
get/health

Request

Response

Healthy

connection_status'connected' | 'disconnected' required

Condition of the connection with the underlying node.

most_recent_checkpointunknown required
most_recent_node_tipunknown required
seconds_since_last_blockinteger required

Number of seconds elapsed since the last block was ingested by Kupo.

network_synchronizationnumber required

A progress percentage of the synchronization towards the node tip.

versionstring required

Current software version.

Changes

No recorded changes to this operation across all 1 revision of this API.