Last updated
Edit

peer_reservations_add

[Source]

The peer_reservations_add method adds or updates a reserved slot for a specific peer server in the XRP Ledger peer-to-peer network.

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

Request Format

An example of the request format:

  1. WebSocket
  2. JSON-RPC
  3. Commandline
{
    "id": "peer_reservations_add_example_1",
    "command": "peer_reservations_add",
    "public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
    "description": "Ripple s1 server 'WOOL'"
}

The request includes the following parameters:

FieldTypeDescription
public_keyStringThe node public key of the peer reservation to add a reservation for, in base58.
descriptionString(Optional) A custom description for the peer reservation. The server truncates descriptions longer than 64 characters when it restarts.

Response Format

An example of a successful response:

  1. WebSocket
  2. JSON-RPC
  3. Commandline
{
  "id": "peer_reservations_add_example_1",
  "result": {
    "previous": {
      "description": "Maecenas atavis edite regibus, O et praesidium et dulce decus meum, Sunt quos curriculo pulverem Olympicum Collegisse iuvat metaque fervidis Evitata rotis palmaque nobilis Terrarum dominos evehit ad deos; Hunc, si mobilium turba Quiritium Certat tergeminis tollere honoribus; Illum, si proprio condidit horreo, Quidquid de Libycis verritur areis.",
      "node": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
    }
  },
  "status": "success",
  "type": "response"
}

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

FieldTypeDescription
previousObject(May be omitted) The previous entry for the same node public key, if there was already a reservation with the same node public key. This object is formatted as a Peer Reservation Object, as described below.

If there was not a previous entry for the same node public key, the result object is empty.

Peer Reservation Object

If the previous field is provided, it shows the previous status of this peer reservation, with the following fields:

FieldTypeDescription
nodeStringThe [node public key][] of the peer server this reservation is for, as [base58][].
descriptionString(May be omitted) The description provided with this peer reservation, if any.

Possible Errors

  • Any of the universal error types.
  • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
  • publicMalformed - The public_key field of the request is not valid. It must be a valid node public key in base58 format.
  • reportingUnsupported - (Reporting Mode servers only) This method is not available in Reporting Mode.