Admin module

admin_addPeer
Adds given node.
Invocation
{"method":"admin_addPeer","params":[enode, addToStaticNodes]}
Parameter
Type
Description
enode
String
Given node
addToStaticNodes
Boolean
Adding to static nodes if true (optional)
Returned type
Description
String
Added node
Example request of admin_addPeer
Example response of admin_addPeer
curl --data '{"method":"admin_addPeer","params":["enode://deed356ddcaa1eb33a859b818a134765fff2a3dd5cd5b3d6cbe08c9424dca53b9[email protected]85.221.141.144:30303", true],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
{
  "jsonrpc": "2.0",
  "result": "enode://deed356ddcaa1eb33a859b818a134765fff2a3dd5cd5b3d6cbe08c9424dca53b9[email protected]85.221.141.144:30303",
  "id": 1
}
​See also CLI admin.addPeer​
admin_nodeInfo
Displays relevant information about this node.
Invocation
{"method":"admin_nodeInfo","params":[]}
Returned type
Description
NodeInfo object
Information about this node
Example request of admin_nodeInfo
Example response of admin_nodeInfo
Objects in admin_nodeInfo
curl --data '{"method":"admin_nodeInfo","params":[],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
{
  "jsonrpc": "2.0",
  "result": {
    "enode": "enode://deed356ddcaa1eb33a859b818a134765fff2a3dd5cd5b3d6cbe08c9424dca53b9[email protected]85.221.141.144:30303",
    "id": "b70bb308924de8247d73844f80561e488ae731105a6ef46004e4579edd4f378a",
    "ip": "85.221.141.144",
    "listenAddr": "85.221.141.144:30303",
    "name": "Nethermind/v1.10.37-0-068e5c399-20210315/X64-Windows/5.0.3",
    "ports": {
      "discovery": 30303,
      "listener": 30303
    },
    "protocols": {
      "eth": {
        "difficulty": "0x6372ca",
        "genesis": "0xbf7e331f7f7c1dd2e05159666b3bf8bc7a8a3a9eb1d518969eab529dd9b88c1a",
        "head": "0xf266b2639ef7e1db6ee769f7b161ef7eb2d74beb0ab8ffcd270036da04b41cd4",
        "network": "0x5"
      }
    }
  },
  "id": 1
}
NodeInfo
Field name
Type
Enode
String
Id
String
Ip
String
ListenAddress
String
Name
String
Ports
PortsInfo object
Protocols
Array
PortsInfo
Field name
Type
Discovery
Quantity
Listener
Quantity
​See also CLI admin.nodeInfo​
admin_peers
Displays a list of connected peers including information about them (clientId, host, port, address, isBootnode, isStatic, enode).
Invocation
{"method":"admin_peers","params":[includeDetails]}
Parameter
Type
Description
includeDetails
Boolean
If true, including clientType, ethDetails and lastSignal (optional)
Returned type
Description
PeerInfo object
List of connected peers including information
Example request of admin_peers
Example response of admin_peers
Objects in admin_peers
curl --data '{"method":"admin_peers","params":[true],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
{
  "jsonrpc": "2.0",
  "result": [
    {
      "clientId": "Nethermind/v1.10.33-1-5c4c185e8-20210310/X64-Linux/5.0.2",
      "host": "94.237.54.114",
      "port": 30313,
      "address": "94.237.54.114:30313",
      "isBootnode": false,
      "isTrusted": false,
      "isStatic": false,
      "enode": "enode://46add44b9f13965f7b9875ac6b85f016f341012d84f975377573800a863526f4d[email protected]94.237.54.114:30313",
      "clientType": "Nethermind",
      "ethDetails": "eth65",
      "lastSignal": "03/11/2021 12:33:58"
    },
    
    (...)
    
  ],
  "id": 1
}
PeerInfo
Field name
Type
ClientId
String
Host
String
Port
Quantity
Address
String
IsBootnode
Boolean
IsTrusted
Boolean
IsStatic
Boolean
Enode
String
ClientType
String
EthDetails
String
LastSignal
String
​See also CLI admin.peers​
admin_prune
Runs full pruning if enabled.
Invocation
{"method":"admin_prune","params":[]}
Returned type
Description
PruningStatus object
​
Example request of admin_prune
Example response of admin_prune
Objects in admin_prune
curl --data '{"method":"admin_prune","params":[],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
{
  "jsonrpc": "2.0",
  "result": "Starting",
  "id": 1
}
PruningStatus
admin_removePeer
Removes given node.
Invocation
{"method":"admin_removePeer","params":[enode, removeFromStaticNodes]}
Parameter
Type
Description
enode
String
Given node
removeFromStaticNodes
Boolean
Removing from static nodes if true (optional)
Returned type
Description
String
Removed node
Example request of admin_removePeer
Example response of admin_removePeer
curl --data '{"method":"admin_removePeer","params":["enode://deed356ddcaa1eb33a859b818a134765fff2a3dd5cd5b3d6cbe08c9424dca53b9[email protected]85.221.141.144:30303", true],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
{
  "jsonrpc": "2.0",
  "result": "enode://deed356ddcaa1eb33a859b818a134765fff2a3dd5cd5b3d6cbe08c9424dca53b9[email protected]85.221.141.144:30303",
  "id": 1
}
​See also CLI admin.removePeer​

Invocation
`{"method":"admin_addPeer","params":[enode, addToStaticNodes]}`

Parameter	Type	Description
enode	`String`	Given node
addToStaticNodes	`Boolean`	Adding to static nodes if `true` (optional)

Returned type	Description
`String`	Added node

Invocation
`{"method":"admin_nodeInfo","params":[]}`

Returned type	Description
`NodeInfo object`	Information about this node

Field name	Type
Enode	`String`
Id	`String`
Ip	`String`
ListenAddress	`String`
Name	`String`
Ports	`PortsInfo object`
Protocols	`Array`

Field name	Type
Discovery	`Quantity`
Listener	`Quantity`

Invocation
`{"method":"admin_peers","params":[includeDetails]}`

Parameter	Type	Description
includeDetails	`Boolean`	If true, including `clientType`, `ethDetails` and `lastSignal` (optional)

Returned type	Description
`PeerInfo object`	List of connected peers including information

Field name	Type
ClientId	`String`
Host	`String`
Port	`Quantity`
Address	`String`
IsBootnode	`Boolean`
IsTrusted	`Boolean`
IsStatic	`Boolean`
Enode	`String`
ClientType	`String`
EthDetails	`String`
LastSignal	`String`

Invocation
`{"method":"admin_prune","params":[]}`

Returned type	Description
`PruningStatus object`

Invocation
`{"method":"admin_removePeer","params":[enode, removeFromStaticNodes]}`

Parameter	Type	Description
enode	`String`	Given node
removeFromStaticNodes	`Boolean`	Removing from static nodes if `true` (optional)

Returned type	Description
`String`	Removed node

Engine JsonRpc Config Example

Clique module

Last modified 11mo ago