ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-27 15:15:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b560c8ab9f51d10367c292587ea9620c28b9f282
xrpl-dev-portal/content/rippled-api-methods/stop.md
mDuo13 45e0f2f70f rippled APIs: reorg methods to separate files
2018-01-22 16:27:33 -08:00

1.4 KiB
Raw Blame History

stop

[Source]

Gracefully shuts down the server.

The stop request is an admin command that cannot be run by unprivileged users!

Request Format

An example of the request format:

WebSocket

{
    "id": 0,
    "command": "stop"
}

JSON-RPC

{
    "method": "stop",
    "params": [
        {}
    ]
}

Commandline

rippled stop

The request includes no parameters.

Response Format

An example of a successful response:

JSON-RPC

{
   "result" : {
      "message" : "ripple server stopping",
      "status" : "success"
   }
}

Commandline

Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "message" : "ripple server stopping",
      "status" : "success"
   }
}

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

Field Type Description
message String ripple server stopping on success.

Possible Errors