Radix System API (v1.2.4)
Download OpenAPI specification:Download
This API is exposed by the Babylon Radix node to give clients access to information about the node itself, its configuration, status and subsystems.
It is intended for use by node-runners on a private network, and is not intended to be exposed publicly. Heavy load may impact the node's function.
If you require queries against ledger state, you may also wish to consider using the Core API or Gateway API instead.
- 200
- default
{- "public_key_hex": "stringstringstringstringstringstringstringstringstringstringstring",
- "node_address": "string",
- "node_uri": "string",
- "node_name": "string",
- "node_id": "string",
- "validator_address": "string",
- "validator_name": "string",
- "consensus_status": "VALIDATING_IN_CURRENT_EPOCH"
}- 200
- default
{- "status": "BOOTING_PRE_GENESIS",
- "detail": "string",
- "recent_self_proposal_miss_statistic": {
- "missed_count": 4294967295,
- "recent_proposals_tracked_count": 4294967295
}, - "current_protocol_version": "string",
- "enacted_protocol_updates": [
- {
- "state_version": 0,
- "resultant_protocol_version": "string"
}
], - "pending_protocol_updates": [
- {
- "protocol_version": "string",
- "state": {
- "type": "ForSignalledReadinessSupportCondition"
}, - "readiness_signal_name": "string",
- "readiness_signal_status": "READINESS_SIGNALLED"
}
], - "unknown_reported_pending_protocol_updates": [
- {
- "protocol_version": "string",
- "reported_by_node_addresses": [
- "string"
]
}
]
}- 200
- default
{- "mempool": {
- "max_size": 0,
- "throttle": 0
}, - "bft": {
- "pacemaker_timeout": 0,
- "bft_sync_patience": 0
}, - "sync": {
- "sync_check_interval": 0,
- "sync_check_max_peers": 0,
- "request_timeout": 0,
- "ledger_status_update_max_peers_to_notify": 0,
- "max_ledger_updates_rate": 0
}, - "networking": {
- "default_port": 0,
- "discovery_interval": 0,
- "listen_address": "string",
- "listen_port": 0,
- "broadcast_port": 0,
- "peer_connection_timeout": 0,
- "max_inbound_channels": 0,
- "max_outbound_channels": 0,
- "channel_buffer_size": 0,
- "peer_liveness_check_interval": 0,
- "ping_timeout": 0,
- "seed_nodes": [
- "string"
], - "node_address": "string"
}, - "protocol": {
- "genesis_protocol_version": "string",
- "protocol_update_triggers": [
- {
- "next_protocol_version": "string",
- "enactment_condition": {
- "type": "EnactAtStartOfEpochIfValidatorsReady"
}
}
]
}
}Create DB Checkpoint
Creates a persistent snapshot (checkpoint) of the state manager database.
This feature needs to be explicitly enabled with the api.system.enable_db_checkpoint flag (defaults to false).
Checkpoints are saved in db.checkpoints_path (defaults to {db.location}/state_manager_checkpoints),
each checkpoint in its own subdirectory (with a name derived from the current time).
If the snapshot is on the same filesystem as the original database,
the SST files will be hard-linked, otherwise SST files will be copied.
The manifest and CURRENT files will be copied.
In addition, if there are multiple column families,
log files will be copied for the period covering the start and end of the checkpoint,
in order to provide a consistent snapshot across column families.
Note that this is a blocking API that waits for the checkpoint to be created before returning,
therefore it is highly NOT recommended to use it for creating checkpoints that result in excessive file copying
(that is, in a checkpoint directory that's on a different filesystem than the database itself).
Returns a relative (to db.checkpoints_path) path to the created checkpoint.
An error occurred
- 200
- default
{- "checkpoint_relative_path": "string"
}