v1

latestOpenAPI 3.0.2Apache 2.02026-07-17292234.0 KB

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/admin/peers

Response

Success

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

How we know about this peer

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

The current state of the connection to the peer

txBytesinteger

The amount of bytes transmitted to this peer

rxBytesinteger

The amount of bytes received from this peer

Example response

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