Operator RPC API

Operator RPCs are exposed under /node and do not require authentication.

GET /node/api

OpenAPI schema

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/backup
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/commit

Current commit level

Latest transaction ID that has been committed on the service

Query Parameters:

  • view_history (boolean) –

  • view_history_since (integer) –

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/config
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/consensus
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/index/strategies
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/js_metrics
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/jwt_keys/refresh/metrics
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/memory
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/metrics
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/network
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/network/nodes
Query Parameters:

  • host (string) –

  • port (string) –

  • status (string) –

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/network/nodes/primary
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/network/nodes/self
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

DELETE /node/network/nodes/{node_id}
Parameters:

  • node_id (string) –

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/network/nodes/{node_id}
Parameters:

  • node_id (string) –

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/network/removable_nodes
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/primary
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

HEAD /node/primary
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/quotes
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/quotes/self
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/ready/app
Status Codes:

  • 204 No Content – Default response description

  • default – An error occurred

GET /node/ready/gov
Status Codes:

  • 204 No Content – Default response description

  • default – An error occurred

GET /node/receipt

Receipt for a transaction

A signed statement from the service over a transaction entry in the ledger

Query Parameters:

  • transaction_id (string) – (Required)

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/self_signed_certificate
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/service/configuration
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/service/previous_identity
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/state
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/tx

Current status of a transaction

Possible statuses returned are Unknown, Pending, Committed or Invalid.

Query Parameters:

  • transaction_id (string) – (Required)

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /node/version
Status Codes:

  • 200 OK – Default response description

  • default – An error occurred