XRP Ledger Apex is back in Amsterdam

Register Now
Last updated



The connect command forces the rippled server to connect to a specific peer rippled server.

The connect method is an admin method that cannot be run by unprivileged users!

Request Format

An example of the request format:

  1. WebSocket
  3. Commandline
    "command": "connect",
    "ip": "",
    "port": 51235

The request includes the following parameters:

ipStringIP address of the server to connect to
portNumber(Optional) Port number to use when connecting. The default is 2459. Updated in: rippled 1.6.0

Response Format

An example of a successful response:

  2. Commandline
   "result" : {
      "message" : "connecting",
      "status" : "success"

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

messageStringThe value connecting, if the command was successful.

Possible Errors

  • Any of the universal error types.
  • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
  • Cannot connect in stand-alone mode - Network-related commands are disabled in stand-alone mode.
  • reportingUnsupported - (Reporting Mode servers only) This method is not available in Reporting Mode.