Files
Mayukha Vadari 0b247281eb run prettier
2026-01-12 14:19:31 -05:00

2.8 KiB

seo, labels
seo labels
description
Force the rippled server to connect to a specific peer.
Core Server

connect

[Source]

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

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

Request Format

An example of the request format:

{% tabs %}

{% tab label="WebSocket" %}

{
  "command": "connect",
  "ip": "192.170.145.88",
  "port": 51235
}

{% /tab %}

{% tab label="JSON-RPC" %}

{
  "method": "connect",
  "params": [
    {
      "ip": "192.170.145.88",
      "port": 51235
    }
  ]
}

{% /tab %}

{% tab label="Commandline" %}

#Syntax: connect ip [port]
rippled connect 192.170.145.88 51235

{% /tab %}

{% /tabs %}

The request includes the following parameters:

Field Type Description
ip String IP address of the server to connect to
port Number (Optional) Port number to use when connecting. The default is 2459. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.6.0" %}Updated in: rippled 1.6.0{% /badge %}

Response Format

An example of a successful response:

{% tabs %}

{% tab label="JSON-RPC" %}

{
  "result": {
    "message": "connecting",
    "status": "success"
  }
}

{% /tab %}

{% tab label="Commandline" %}

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

{
   "result" : {
      "message" : "connecting",
      "status" : "success"
   }
}

{% /tab %}

{% /tabs %}

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

Field Type Description
message String The 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.

{% raw-partial file="/docs/_snippets/common-links.md" /%}