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/attestations¶
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /node/attestations/self¶
- 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/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/ledger-chunk¶
Download ledger chunk
Redirect to the corresponding /node/ledger-chunk/{chunk_name} endpoint for the ledger chunk including the sequence number specified in the ‘since’ query parameter.
- Query Parameters:
since (integer) – (Required)
- Status Codes:
200 OK – Default response description
default – An error occurred
- HEAD /node/ledger-chunk¶
Ledger chunk metadata
Redirect to the corresponding /node/ledger-chunk/{chunk_name} endpoint for the ledger chunk including the sequence number specified in the ‘since’ query parameter.
- Query Parameters:
since (integer) – (Required)
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /node/ledger-chunk/{chunk_name}¶
Download ledger chunk
Download a specific ledger chunk by name. Supports HTTP Range header for partial downloads.
- Parameters:
chunk_name (string)
- Status Codes:
200 OK – Default response description
default – An error occurred
- HEAD /node/ledger-chunk/{chunk_name}¶
Ledger chunk metadata
Metadata about a specific ledger chunk (Content-Length and x-ms-ccf-ledger-chunk-name)
- Parameters:
chunk_name (string)
- 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/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/snapshot¶
- Query Parameters:
since (integer)
- Status Codes:
200 OK – Default response description
default – An error occurred
- HEAD /node/snapshot¶
- Query Parameters:
since (integer)
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /node/snapshot/{snapshot_name}¶
- Parameters:
snapshot_name (string)
- Status Codes:
200 OK – Default response description
default – An error occurred
- HEAD /node/snapshot/{snapshot_name}¶
- Parameters:
snapshot_name (string)
- Status Codes:
200 OK – Default response description
default – An error occurred