Get basic information about all configured peers

GET 
//v1/node/peers

Get basic information about all configured peers

Responses

200

A list of all peers

application/json

Schema

Schema

Array [
isAlivebooleanrequired
Whether or not the peer is activated
isTrustedbooleanrequired
namestringrequired
numUsersint32required
The amount of users attached to the peer
peeringURLstringrequired
The peering URL of the peer
publicKeystringrequired
The peers public key encoded in Hex
]

Example (auto)

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

401

Unauthorized (Wrong permissions, missing token)

application/json

Schema

Schema

errorstringrequired
missingPermissionstringrequired

Example (auto)

{
  "error": "error",
  "missingPermission": "missingPermission"
}

Authorization: Authorization

name: Authorizationtype: apiKeydescription: JWT Tokenin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/v1/node/peers");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "<Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

Auth

Authorization

ResponseClear

Click the Send API Request button above and see the response here!