Control RPCs#

Debug#

The debug RPC changes the debug category from the console.

❗️

Breaking change(s) in Dash Core 18.0. See parameter and/or response information for details.

Parameter #1—debug category

Name

Type

Presence

Description

Debug category

string

Required
(1 or more)

The debug category to activate. Use a + to specify multiple categories. Categories will be one of the following:
• 0 - Disables all categories
• 1 or all - Enables all categories
• addrman
• bench
• cmpctblock
• coindb
• walletdb (renamed from db in Dash Core 18.0.0)
• estimatefee
• http
• i2p
• leveldb
• mempool
• mempoolrej
• net
• netconn
• proxy
• prune
• qt
• rand
• reindex
• rpc
• selectcoins
• tor
• validation
• zmq
• dash (all subcategories)

The dash sub-categories can be enabled individually:
• chainlocks
• coinjoin
• creditpool
• ehf
• gobject
• instantsend
• llmq
• llmq-dkg
• llmq-sigs
• mnpayments
• mnsync
• spork


Note: No error will be thrown even if the specified category doesn’t match any of the above

Note: libevent logging is configured on startup and cannot be modified by this RPC during runtime.

Example from Dash Core 20.0.1

dash-cli -testnet debug "net+mempool"

Result:

Debug mode: net+mempool

See also

  • Logging: gets and sets the logging configuration

GetMemoryInfo#

Added in Dash Core 0.12.3 / Bitcoin Core 0.14.0

The getmemoryinfo RPC returns information about memory usage.

Parameter #1—mode

Name

Type

Presence

Description

mode

string

Optional
Default: stats

Added in Dash Core 0.15.0

Determines what kind of information is returned.
- stats returns general statistics about memory usage in the daemon.
- mallocinfo returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+).

Result—information about memory usage

Name

Type

Presence

Description

result

object

Required
(exactly 1)

An object containing information about memory usage

→
locked

string : object

Required
(exactly 1)

An object containing information about locked memory manager

→→
used

number (int)

Required
(exactly 1)

Number of bytes used

→→
free

number (int)

Required
(exactly 1)

Number of bytes available in current arenas

→→
total

number (int)

Required
(exactly 1)

Total number of bytes managed

→→
locked

number (int)

Required
(exactly 1)

Amount of bytes that succeeded locking

→→
chunks_used

number (int)

Required
(exactly 1)

Number allocated chunks

→→
chunks_free

number (int)

Required
(exactly 1)

Number unused chunks

Example from Dash Core 0.12.3

dash-cli getmemoryinfo

Result:

{
  "locked": {
    "used": 1146240,
    "free": 426624,
    "total": 1572864,
    "locked": 1572864,
    "chunks_used": 16368,
    "chunks_free": 7
  }
}

See also

  • GetMemPoolInfo: returns information about the node’s current transaction memory pool.

GetRPCInfo#

Added in Dash Core 18.0.0

The getrpcinfo RPC returns details about the RPC server.

Parameters: none

Result—information about the RPC server

Name

Type

Presence

Description

result

object

Required
(exactly 1)

An object containing information about the RPC server

→
active_commands

array of objects

Required
(exactly 1)

An object containing information about active RPC commands

→→
Active command

object

Optional
(0 or more)

Information about a currently active command

→→→
method

number (int)

Required
(exactly 1)

Name of the command

→→→
duration

number (int)

Required
(exactly 1)

Number of microseconds the command has been active

Example from Dash Core 18.0.0

dash-cli getrpcinfo

Result:

{
  "active_commands": [
    {
      "method": "generate",
      "duration": 5226138
    },
    {
      "method": "getrpcinfo",
      "duration": 5
    }
  ]
}

See also: none

Help#

The help RPC lists all available public RPC commands, or gets help for the specified RPC. Commands which are unavailable will not be listed, such as wallet RPCs if wallet support is disabled.

Parameter #1—the name of the RPC to get help for

Name

Type

Presence

Description

RPC

string

Optional
(0 or 1)

The name of the RPC to get help for. If omitted, Dash Core 0.10x will display an alphabetical list of commands; Dash Core 0.11.0 will display a categorized list of commands

Parameter #2—the name of the subcommand to get help for

Name

Type

Presence

Description

Sub-command

string

Optional
(0 or 1)

The subcommand to get help on. Please note that not all subcommands support this at the moment

Result—a list of RPCs or detailed help for a specific RPC

Name

Type

Presence

Description

result

string

Required
(exactly 1)

The help text for the specified RPC or the list of commands. The dash-cli command will parse this text and format it as human-readable text

Example from Dash Core 0.17.0

Command to get help about the help RPC:

dash-cli -testnet help help

Result:

help ( "command" "subcommand" )

List all commands, or get help for a specified command.

Arguments:
1. "command"     (string, optional) The command to get help on
2. "subcommand"  (string, optional) The subcommand to get help on. Please note that not all subcommands support this at the moment

Result:
"text"     (string) The help text

See also

Logging#

The logging RPC gets and sets the logging configuration. When called without an argument, returns the list of categories with status that are currently being debug logged or not. When called with arguments, adds or removes categories from debug logging and return the lists above. The arguments are evaluated in order “include”, “exclude”. If an item is both included and excluded, it will thus end up being excluded.

❗️

Breaking change(s) in Dash Core 18.0. See parameter and/or response information for details.

Parameter #1—include categories

Name

Type

Presence

Description

include

array of strings

Optional
(0 or 1)

Enable debugging for these categories

Parameter #2—exclude categories

Name

Type

Presence

Description

exclude

array of strings

Optional
(0 or 1)

Enable debugging for these categories

The categories are:

Type

Category

Special

• 0 or none - Disables all categories
• 1 or all - Enables all categories
• dash - Enables/disables all Dash categories

Standard

addrman, bench
cmpctblock, coindb, estimatefee, http, i2p, leveldb, libevent, mempool, mempoolrej, net, netconn, proxy, prune, qt, rand, reindex, rpc, selectcoins, tor, walletdb (renamed from db in Dash Core 18.0.0), validation, zmq

Dash

chainlocks, coinjoin, creditpool, ehf, gobject, instantsend, llmq, llmq-dkg, llmq-sigs, mnpayments, mnsync, spork

Result—a list of the logging categories that are active

Name

Type

Presence

Description

result

object

Required
(exactly 1)

A JSON object show a list of the logging categories that are active

Example from Dash Core 20.0.1

Include a category in logging

dash-cli -testnet logging '["llmq", "spork"]'

Result:

{
  "net": false,
  "tor": false,
  "mempool": false,
  "http": false,
  "bench": false,
  "zmq": false,
  "walletdb": false,
  "rpc": false,
  "estimatefee": false,
  "addrman": false,
  "selectcoins": false,
  "reindex": false,
  "cmpctblock": false,
  "rand": false,
  "prune": false,
  "proxy": false,
  "mempoolrej": false,
  "libevent": false,
  "coindb": false,
  "qt": false,
  "leveldb": false,
  "validation": false,
  "i2p": false,
  "chainlocks": false,
  "gobject": false,
  "instantsend": false,
  "llmq": true,
  "llmq-dkg": false,
  "llmq-sigs": false,
  "mnpayments": false,
  "mnsync": false,
  "coinjoin": false,
  "spork": true,
  "netconn": false,
  "creditpool": false,
  "ehf": false
}

Excluding a previously included category (without including any new ones):

dash-cli -testnet logging '[]' '["spork"]'

Result:

{
  "net": false,
  "tor": false,
  "mempool": false,
  "http": false,
  "bench": false,
  "zmq": false,
  "walletdb": false,
  "rpc": false,
  "estimatefee": false,
  "addrman": false,
  "selectcoins": false,
  "reindex": false,
  "cmpctblock": false,
  "rand": false,
  "prune": false,
  "proxy": false,
  "mempoolrej": false,
  "libevent": false,
  "coindb": false,
  "qt": false,
  "leveldb": false,
  "validation": false,
  "i2p": false,
  "chainlocks": false,
  "gobject": false,
  "instantsend": false,
  "llmq": true,
  "llmq-dkg": false,
  "llmq-sigs": false,
  "mnpayments": false,
  "mnsync": false,
  "coinjoin": false,
  "spork": false,
  "netconn": false,
  "creditpool": false,
  "ehf": false
}

See also

  • Debug: changes the debug category from the console.

Stop#

The stop RPC safely shuts down the Dash Core server.

Parameters: none

Result—the server is safely shut down

Name

Type

Presence

Description

result

string

Required
(exactly 1)

The string \Dash Core server stopping””

Example from Dash Core 0.12.2

dash-cli -testnet stop

Result:

Dash Core server stopping

See also: none

Uptime#

The uptime RPC returns the total uptime of the server.

Parameters: none

Result

Name

Type

Presence

Description

result

number (int)

Required
(exactly 1)

The number of seconds that the server has been running

Example from Dash Core 0.15.0

dash-cli -testnet uptime

Result:

5500

See also: none