Add a given peer to the node.

POST 
/api/v1/peers

Add a given peer to the node.

Request

application/json

Body

required

multiAddress stringrequired
alias string

Responses

200

Successful operation.

application/json

Schema

Schema

data Peer

The peer of a node.

id stringrequired

The identifier of the peer.

multiAddresses string[]required

The addresses of the peer.

alias string

The alias of the peer.

relation stringrequired

Possible values: [known, unknown, autopeered]

connected booleanrequired

Tells whether the peer is connected or not.

gossip Gossiprequired

Information about the gossip stream with the peer.

heartbeat Heartbeatnullable

Information about the most recent heartbeat of the peer. The heartbeat is null if none has been received yet.

solidMilestoneIndex integer

The most recent milestone that has been solidified by the node.

prunedMilestoneIndex integer

Tells from which starting point the node holds data.

latestMilestoneIndex integer

The most recent milestone known to the node.

connectedNeighbors integer

Tells how many connected peers the node has.

syncedNeighbors integer

Tells how many synced peers the node has.

metrics Metrics

Metrics about the gossip stream with the peer.

newMessages integerrequired

The number of received messages that were new for the node.

knownMessages integerrequired

The number of received messages that already were known to the node.

receivedMessages integerrequired

The number of received messages from the peer.

receivedMessageRequests integerrequired

The number of received message requests from the peer.

receivedMilestoneRequests integerrequired

The number of received milestone requests from the peer.

receivedHeartbeats integerrequired

The number of received heartbeats from the peer.

sentMessages integerrequired

The number of sent messages to the peer.

sentMessageRequests integerrequired

The number of sent message requests to the peer.

sentMilestoneRequests integerrequired

The number of sent milestone requests to the peer.

sentHeartbeats integerrequired

The number of sent heartbeats to the peer.

droppedPackets integerrequired

The number of dropped packets.

Example (from schema)

{
  "data": {
    "id": "string",
    "multiAddresses": [
      "string"
    ],
    "alias": "string",
    "relation": "known",
    "connected": true,
    "gossip": {
      "heartbeat": {
        "solidMilestoneIndex": 0,
        "prunedMilestoneIndex": 0,
        "latestMilestoneIndex": 0,
        "connectedNeighbors": 0,
        "syncedNeighbors": 0
      },
      "metrics": {
        "newMessages": 0,
        "knownMessages": 0,
        "receivedMessages": 0,
        "receivedMessageRequests": 0,
        "receivedMilestoneRequests": 0,
        "receivedHeartbeats": 0,
        "sentMessages": 0,
        "sentMessageRequests": 0,
        "sentMilestoneRequests": 0,
        "sentHeartbeats": 0,
        "droppedPackets": 0
      }
    }
  }
}

default

{
  "data": {
    "id": "12D3KooWMajsSUxSUFb3CRgmJvygYCGd27uMDdppVYNGud7xuKG5",
    "multiAddresses": [
      "/dns/abc.com/tcp/15602"
    ],
    "alias": "abc",
    "relation": "known",
    "connected": true,
    "gossip": {
      "heartbeat": {
        "solidMilestoneIndex": 61527,
        "prunedMilestoneIndex": 61200,
        "latestMilestoneIndex": 61527,
        "connectedNeighbors": 5,
        "syncedNeighbors": 7
      },
      "metrics": {
        "newMessages": 3799,
        "knownMessages": 554,
        "receivedMessages": 4370,
        "receivedMessageRequests": 0,
        "receivedMilestoneRequests": 1,
        "receivedHeartbeats": 1,
        "sentMessages": 6,
        "sentMessageRequests": 4325,
        "sentMilestoneRequests": 31,
        "sentHeartbeats": 9,
        "droppedPackets": 0
      }
    }
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

Loading...