xrpl-dev-portal/content/references/rippled-api/admin-rippled-methods/peer-management-methods/peer_reservations_add.md

peer_reservations_add

[Source]

The {{currentpage.name}} method adds or updates a reserved slot for a specific peer server in the XRP Ledger peer-to-peer network. [New in: rippled 1.4.0][]

The {{currentpage.name}} method is an admin method that cannot be run by unprivileged users.

Request Format

An example of the request format:

WebSocket

{
    "id": "peer_reservations_add_example_1",
    "command": "{{currentpage.name}}",
    "public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
    "description": "Ripple s1 server 'WOOL'"
}

JSON-RPC

{
    "method": "{{currentpage.name}}",
    "params": [{
      "public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
      "description": "Ripple s1 server 'WOOL'"
    }]
}

Commandline

#Syntax: {{currentpage.name}} <public_key> [<description>]
rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99 "Ripple s1 server 'WOOL'"

The request includes the following parameters:

Field	Type	Description
public_key	String	The [node public key][] of the peer reservation to add a reservation for, in [base58][].
description	String	(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:

WebSocket

{
  "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"
}

JSON-RPC

{
  "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"
  }
}

Commandline

Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005

{
  "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"
  }
}

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

Field	Type	Description
previous	Object	(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:

{% include '_snippets/peer_reservation_object.md' %}

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.

{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}