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.

Get Version

Responses
200

Version

default

Unexpected error

get/version
Response samples
application/json
{
  • "version": "string"
}

Get Node Identity

Responses
200

Node Identity

default

Unexpected error

get/identity
Response samples
application/json
{
  • "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"
}

Get Health

Responses
200

Health

default

Unexpected error

get/health
Response samples
application/json
{
  • "status": "BOOTING_PRE_GENESIS",
  • "detail": "string",
  • "recent_self_proposal_miss_statistic": {
    },
  • "current_protocol_version": "string",
  • "enacted_protocol_updates": [
    ],
  • "pending_protocol_updates": [
    ],
  • "unknown_reported_pending_protocol_updates": [
    ]
}

Get Configuration

Responses
200

System Configuration

default

Unexpected error

get/configuration
Response samples
application/json
{
  • "mempool": {
    },
  • "bft": {
    },
  • "sync": {
    },
  • "networking": {
    },
  • "protocol": {
    }
}

Get Peers

Responses
200

Peers

default

Unexpected error

get/peers
Response samples
application/json
{
  • "peers": [
    ]
}

Get Address Book

Responses
200

Address Book

default

Unexpected error

get/addressbook
Response samples
application/json
{
  • "entries": [
    ]
}

Get Network Sync Status

Returns the current sync status of the node.

Responses
200

Network Status

default

Unexpected error

get/network-sync-status
Response samples
application/json
{
  • "sync_status": {
    }
}

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).

Responses
200

Returns a relative (to db.checkpoints_path) path to the created checkpoint.

default

An error occurred

post/db-checkpoint
Response samples
application/json
{
  • "checkpoint_relative_path": "string"
}