Check basic node health
GET/-/healthy
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
Request
Query Parameters
Threshold in seconds that the server can be behind to be considered healthy
If not provided, the healthcheck will always succeed
Responses
- 200
- 500
- 503
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version 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-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
X-APTOS-CURSOR
string
Cursor to be used for endpoints that support cursor-based pagination. Pass this to the
startfield of the endpoint on the next call to get the next page of results.
- application/json
- application/x-bcs
- Schema
- Example (from schema)
Schema
{
"message": "string"
}
- Schema
- Example (from schema)
Schema
Array [
]
integer
[
0
]
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version 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-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]
These codes provide more granular error information beyond just the HTTP status code of the response.
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version 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-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]
These codes provide more granular error information beyond just the HTTP status code of the response.
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}