mainbridge_removePeer

Adds a new remote node to the peer list. The node will try to maintain connectivity to these nodes at all times, reconnecting every once in a while if the remote connection goes down. The method accepts a single argument, the kni URL of the remote peer to start tracking and returns a BOOL indicating whether the peer was accepted for tracking or some error occurred.

JSONRPC: mainbridge_removePeer

Request

application/json

Body

method stringrequired

Default value: mainbridge_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 string[]

Responses

200

Returns bridge node information including the KNI (Klaytn Network Identifier) of the node.

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

Example (from schema)

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

• curl
• python
• nodejs
• java

• CURL

curl -L -X POST 'http://localhost:8551/mainbridge/removePeer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "method": "mainbridge_removePeer",
  "id": 1,
  "jsonrpc": "2.0",
  "params": [
    "kni://a979fb...1163c@10.0.0.1:50505"
  ]
}'

Request Collapse all

Base URL

http://localhost:8551

Body

{
  "method": "mainbridge_removePeer",
  "id": 1,
  "jsonrpc": "2.0",
  "params": [
    "kni://a979fb...1163c@10.0.0.1:50505"
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!