Sign in
Admin
Peer

List known peers

List all peers known in the system, and info about their connection. This includes the endpoint, how we know about the peer, the connection state, and if the connection is alive the amount of bytes we've sent to and received from the peer.

get/api/v1/peers

Response

Succes

type'static' | 'inbound' | 'linkLocalDiscovery'

How we know about this peer

connectionState'alive' | 'connecting' | 'dead'

The current state of the connection to the peer

connectionTxBytesinteger

The amount of bytes transmitted on the current connection

connectionRxBytesinteger

The amount of bytes received on the current connection

Example response

[
  {
    "endpoint": {
      "proto": "tcp",
      "socketAddr": "192.0.2.6:9651"
    },
    "type": "static",
    "connectionState": "alive",
    "connectionTxBytes": 464531564,
    "connectionRxBytes": 64645089
  }
]

Changes