xrpl-dev-portal/content/references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md

html, parent, blurb, labels

html	parent	blurb	labels
stop.html	server-control-methods.html	Shut down the rippled server.	Core Server

stop

[Source]

Gracefully shuts down the server.

The stop method is an admin method 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

#Syntax: stop
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

• Any of the [universal error types][].

{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}