connect

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!

An example of the request format:

WebSocket

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

JSON-RPC

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

Commandline

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

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. [Updated in: rippled 1.6.0][]

An example of a successful response:

JSON-RPC

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

Commandline

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

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

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.

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 standalone mode - Network-related commands are disabled in stand-alone mode.
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' %}