peer_reservations_list

[Source]

The peer_reservations_list method lists peer reservations. New in: rippled 1.4.0

The peer_reservations_list method is an admin method that cannot be run by unprivileged users.

Request Format

An example of the request format:

{
  "id": "peer_reservations_list_example_1",
  "command": "peer_reservations_list"
}

{
    "method": "peer_reservations_list"
}

#Syntax: peer_reservations_list
rippled peer_reservations_list

This request does not take any parameters.

Response Format

An example of a successful response:

{
  "id": "peer_reservations_list_example_1",
  "result": {
    "reservations": [
      {
        "description": "Ripple s1 server 'WOOL'",
        "node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
      },
      {
        "node": "n9MZRo92mzYjjsa5XcqnPC7GFYAnENo9VfJzKmpcS9EFZvw5fgwz"
      }
    ]
  },
  "status": "success",
  "type": "response"
}

{
  "result" : {
    "reservations" : [
       {
          "description" : "Ripple s1 server 'WOOL'",
          "node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
       },
       {
          "node" : "n9MZRo92mzYjjsa5XcqnPC7GFYAnENo9VfJzKmpcS9EFZvw5fgwz"
       }
    ],
    "status" : "success"
  }
}

Loading: "/etc/rippled.cfg"
2019-Dec-27 21:56:07.253260422 HTTPClient:NFO Connecting to 127.0.0.1:5005

{
  "result" : {
    "reservations" : [
       {
          "description" : "Ripple s1 server 'WOOL'",
          "node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
       },
       {
          "node" : "n9MZRo92mzYjjsa5XcqnPC7GFYAnENo9VfJzKmpcS9EFZvw5fgwz"
       }
    ],
    "status" : "success"
  }
}

The response follows the standard format, with a successful result containing the following fields:

Field Type Description
reservations Array List of existing peer reservations. Each member is a peer reservation object, as described below.

Peer Reservation Object

Each member of the reservations array is a JSON object describing one peer reservation. This object has the following fields:

Field Type Description
node String The node public key of the peer server this reservation is for, as base58.
description String (May be omitted) The description provided with this peer reservation, if any.

Possible Errors