/v1/-/healthy

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

Parameters

  • duration_secs OPTIONAL: (integer) - Threshold in seconds that the server can be behind to be considered healthy.

    If not provided, the health check will always succeed.

Example

Request

curl --request GET \
  --url https://aptos-mainnet.blastapi.io/<project-id>/v1/-/healthy?duration_secs=5 \
  --header 'Content-Type: application/json'

Result

{
  "message": "aptos-node:ok"
}

Last updated