Skip to content

Admin API Methods

These methods are intended exclusively for trusted personnel responsible for maintaining xahaud server operations.

MethodDescription
validation_createGenerate a formatted key pair for xhaud nodes. (Validators should use tokens instead of keys from this method.)
wallet_proposeGenerate keys for a new account.
MethodDescription
can_deleteEnable online deletion of ledgers up to a specified ledger.
download_shardDownload a specific shard of ledger history.
ledger_cleanerSet up the ledger cleaner to detect and resolve corrupted data.
ledger_requestQuery a peer server for a specific ledger version.
log_levelView or change log verbosity levels.
logrotateReopen the log file.
node_to_shardTransfer data from the ledger store to the shard store.

These methods create, load, and monitor catalogue files — archives of historical ledger ranges used to build archival and historical-query nodes.

MethodDescription
catalogue_createStream a range of ledgers into a single archive file (optionally compressed).
catalogue_loadLoad ledgers from a catalogue file and pin them. Requires pinned_type to be configured.
catalogue_statusReport progress of an in-flight catalogue create/load job.
MethodDescription
ledger_acceptClose and advance the ledger in stand-alone mode.
stopShut down the xahaud server.
MethodDescription
signCryptographically sign a transaction.
sign_forContribute to a multi-signature.
MethodDescription
connectForce the server to connect to a specific peer.
peer_reservations_addAdd or update a reserved slot for a specific peer.
peer_reservations_delRemove a reserved slot for a specific peer.
peer_reservations_listView all reserved peer slots.
peersRetrieve information about connected peers
MethodDescription
consensus_infoView the current state of the consensus process.
featureRetrieve information about protocol amendments.
fetch_infoCheck the server’s synchronization status with the network.
get_countsView statistics about server internals and memory usage.
manifestRetrieve public key details for a known validator.
printAccess information about internal subsystems.
validator_infoGet the server’s validator configuration details.
validator_list_sitesView sites that publish validator lists.
validatorsRetrieve information about the current validators.