BlockPI Network
Search
⌃K
Comment on page

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

Path Parameters:

None

Query Parameters:

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

Response Header:

X-APTOS-BLOCK-HEIGHT integer
Current block height of the chain
X-APTOS-CHAIN-ID integer
Chain ID of the current chain
X-APTOS-EPOCH integer
Current epoch of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer
Current timestamp of the chain
X-APTOS-LEDGER-VERSION integer
Current ledger version of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer
Oldest non-pruned block height of the chain

Response Body:

Representation of a successful healthcheck
message string

Example:

// Request
curl -X GET -H 'Content-Type: application/json' https://aptos.blockpi.network/aptos/v1/your_api_key/v1/-/healthy
​
// Result
{
"message": "aptos-node:ok"
}