Radix System API (1.0.0)

Download OpenAPI specification:Download

Get Version

Responses
200

Version

default

Unexpected error

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

Get Health

Responses
200

Health

default

Unexpected error

get/system/health
Response samples
application/json
{
  • "status": "BOOTING",
  • "current_fork_name": "string",
  • "executed_forks": [
    ],
  • "fork_vote_status": "VOTE_REQUIRED",
  • "unknown_reported_forks": [
    ]
}

Get Configuration

Responses
200

System Configuration

default

Unexpected error

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

Get Peers

Responses
200

Peers

default

Unexpected error

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

Get Address Book

Responses
200

Address Book

default

Unexpected error

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

Get Metrics

Responses
200

System Metrics

default

Unexpected error

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

Get Prometheus Metrics

Responses
200

Prometheus Metrics

default

Unexpected error

get/prometheus/metrics
Response samples
application/json
{
  • "code": 0,
  • "message": "string"
}