Skip to main content

Debug & Admin APIs

Endpoints for administrative operations and debugging. All endpoints require admin password authentication unless otherwise specified.

Base Configuration

  • Default Port: 22024
  • Account Address Format: SHAMWARI-XXXX-XXXX-XXXX-XXXXX

Endpoints

EndpointDescriptionMethodParameters
SetConfigurationUpdate node configuration and optionally shutdownPOSTpropertiesJSON, shutdown
GetConfigurationGet current node configurationGETadminPassword
SetLoggingUpdate log level and communication loggingPOSTlogLevel, communicationLogging, adminPassword
ShutdownShutdown the node (optionally after blockchain scan)POSTscan, adminPassword
FullResetPerform a full blockchain resetPOSTadminPassword
PopOffRemove recent blocks from blockchainPOSTnumBlocks, height, keepTransactions, adminPassword
ScanScan blockchain for validationPOSTnumBlocks, height, validate, adminPassword
GetLogGet log entries from the ring bufferGETcount, adminPassword
GetStackTracesGet stack traces for all threadsGETdepth, adminPassword
LuceneReindexReindex full-text search databasePOSTadminPassword
RetrievePrunedDataRestore pruned data from peersPOSTchain, adminPassword
TrimDerivedTablesTrim derived tables from databasePOSTadminPassword
DumpPeersDump connected peer addressesPOSTversion, includeNewer, connect, service
GetAllWaitingTransactionsGet all waiting (unconfirmed) transactionsGET(none)
GetAllBroadcastedTransactionsGet all broadcasted (unconfirmed) transactionsGETadminPassword
ClearUnconfirmedTransactionsClear all unconfirmed transactionsPOSTadminPassword
RequeueUnconfirmedTransactionsRequeue all unconfirmed transactionsPOSTadminPassword
RebroadcastUnconfirmedTransactionsRebroadcast all unconfirmed transactionsPOSTadminPassword