node

Get basic information about all configured peers

Changed on
get/v1/node/peers

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/node/peers
  • Auth
    API key in header Authorization

Response

A list of all peers

isAliveboolean required

Whether or not the peer is activated

isTrustedboolean required
namestring string required
numUsersinteger required

The amount of users attached to the peer

peeringURLstring string required

The peering URL of the peer

publicKeystring string required

The peers public key encoded in Hex

Example response

[
  {
    "isAlive": true,
    "peeringURL": "localhost:4000",
    "name": "name",
    "publicKey": 0,
    "numUsers": 1,
    "isTrusted": true
  }
]

Changes