admin namespace

admin_addPeer

Adds given node.

Parameters

1. enode: string

2. addToStaticNodes: boolean

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "admin_addPeer",
      "params": [enode, addToStaticNodes]
    }'

Response

Added node

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: string

admin_nodeInfo

Displays relevant information about this node.

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "admin_nodeInfo",
      "params": []
    }'

Response

Information about this node

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• enode: string
• id: string
• ip: string
• listenAddress: string
• name: string
• ports: object
  • discovery: string (hex integer)
  • listener: string (hex integer)
• protocols: map of object
  • difficulty: string (hex integer)
  • genesisHash: string (hash)
  • headHash: string (hash)
  • newtorkId: string (hex integer)

admin_peers

Displays a list of connected peers including information about them (clientId, host, port, address, isBootnode, isStatic, enode).

Parameters

1. includeDetails: boolean

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "admin_peers",
      "params": [includeDetails]
    }'

Response

List of connected peers including information

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of object

• address: string
• clientId: string
• clientType: string
• enode: string
• ethDetails: string
• host: string
• isBootnode: boolean
• isStatic: boolean
• isTrusted: boolean
• lastSignal: string
• port: string (hex integer)

admin_prune

Runs full pruning if enabled.

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "admin_prune",
      "params": []
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: integer

admin_removePeer

Removes given node.

Parameters

1. enode: string

2. removeFromStaticNodes: boolean

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "admin_removePeer",
      "params": [enode, removeFromStaticNodes]
    }'

Response

Removed node

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: string