Control RPC Commands
Documentation for Raptoreum Control RPC calls.
getmemoryinfo
- "mode" (string, optional, default="stats") determines what kind of information is returned.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | mode |
string | Optional | "stats" | See CLI help for details |
Examples
raptoreum-cli getmemoryinfo
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmemoryinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
getrpcinfo
Returns details of the RPC server.
Arguments
No arguments.
Result
{ (json object)
"active_commands" : [ (json array) All active commands
{ (json object) Information about an active command
"method" : "str", (string) The name of the RPC command
"duration" : n (numeric) The running time in microseconds
},
...
],
"logpath" : "str" (string) The complete file path to the debug log
}
Examples
raptoreum-cli getrpcinfo
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrpcinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
help
List all commands, or get help for a specified command.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | command |
string | Optional | all commands | See CLI help for details |
| 2 | subcommand |
string | Optional | all subcommands | See CLI help for details |
Result
"str" (string) The help text
logging
When called without an argument, returns the list of categories with status that are currently being debug logged or not.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
{ (json object) where keys are the logging categories, and values indicates its status
"category" : true|false, (boolean) if being debug logged or not. false:inactive, true:active
...
}
Examples
raptoreum-cli logging "[\"all\"]" "[\"http\"]"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "logging", "params": [["all"], "[libevent]"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
stop
Stop Raptoreum Core server.
Arguments
No arguments.
Result
"str" (string) A string with the content 'Raptoreum Core stopping'
uptime
Returns the total uptime of the server.
Arguments
No arguments.
Result
n (numeric) The number of seconds that the server has been running
Examples
raptoreum-cli uptime
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "uptime", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/