NOnodereal
General

Check basic node health

By default this endpoint just checks that it can get the latest ledger info and then returns 200.

If the duration_secs param is provided, this endpoint will return a 200 if the following condition is true:

server_latest_ledger_info_timestamp >= server_current_time_timestamp - duration_secs

get/-/healthy

Request

  • Base URL
    aptos-mainnet.nodereal.io/v1/{api_key}/v1 (relative, and the document’s source URL is not known)
  • URL
    aptos-mainnet.nodereal.io/v1/{api_key}/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

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