Skip to main content

/v1/healthy REST API Endpoint

Checks the health status of the node.

Updated on
Oct 4, 2023

/v1/healthy REST API Endpoint

Please note that 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.

Query Parameters

duration_secs
integer
REQUIRED
The duration in seconds for which the server can be behind to be considered healthy

Returns

message
It indicates the health status of the blockchain. If healthy, the blockchain network is functioning correctly and is in a healthy state. If unhealthy, the blockchain network is experiencing issues or is in an unhealthy state
Request
1
curl -X 'GET' 'https://docs-demo.aptos-mainnet.quiknode.pro/v1/-/healthy' \
2
    -H 'Content-Type: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free