Skip to main content

Add a given peer to the node.

POST 

/api/v1/peers

Add a given peer to the node.

Request

Body

required
    multiAddress stringrequired
    alias string

Responses

Successful operation.

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.

Loading...