ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-21 12:15:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
486b475623c35df10a2a82c775942893a0d0d0b7
xrpl-dev-portal/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/connect.md
mDuo13 7645140477 Re-levelization: move non-docs content, rename content→docs 
For better URLs, the content folder has been renamed 'docs' and all
other files have been moved up a level. Also, non-docs images have been
moved to the static folder at the top level where they belong.

Many relative paths had to be fixed to make this work.
2024-01-31 17:53:52 -08:00

2.7 KiB
Raw Blame History

html, parent, seo, labels
html parent seo labels
connect.html peer-management-methods.html
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 rippled 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.
  • reportingUnsupported - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.

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