admin_removePeer

The removePeer is an administrative method that requests removing a node from the list of tracked static nodes.

The method accepts a single argument kni, which means "Klaytn Network Identifier". It is similar to the enode concept in the geth. It is URL of the remote peer to be removed from a list and returns a BOOL indicating whether the peer was removed or some error occurred.

JSONRPC: admin_removePeer

Request

application/json

Body

method stringrequired

Default value: admin_removePeer

Method name

id int64required

Default value: 1

Request ID, Random or Auto incrementation

jsonrpc stringrequired

Default value: 2.0

JSON-RPC Version (2.0)

params Url[]required

Peer's kni URL.

Responses

200

true if the peer was accepted, false otherwise.

application/json

Schema

Schema

jsonrpc stringrequired

Default value: 2.0

id int64required

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

| code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result boolean

true if the peer was accepted, false otherwise.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": true
}

Loading...