APaptoslabs
General

Check basic node health

Changed on

Without duration_secs, this endpoint returns 200 as long as the node is running. It is a liveness check, so a node that is still bootstrapping (and therefore has no ledger data yet) still passes: it is alive and must not be restarted.

With duration_secs, it returns 200 only if

server_latest_ledger_info_timestamp >= server_current_time_timestamp - duration_secs

which makes it a readiness check instead: a node that has not caught up, or has not bootstrapped at all, fails it.

get/-/healthy

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/-/healthy
  • Auth
    none declared

Query parameters

duration_secsinteger

Threshold in seconds that the server can be behind to be considered healthy

If not provided, the healthcheck will always succeed

Response

messagestring required

Changes

  • fddae5eeba26Revision changes
    • warning

      added the new node_not_bootstrapped enum value to the response property for the response status

    • warning

      added the new node_not_bootstrapped enum value to the response property for the response status

  • 10ecd1005697Revision changes
    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status