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

html, parent, seo, labels

html	parent	seo	labels
stop.html	server-control-methods.html	description 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:

{% tabs %}

{% tab label="WebSocket" %}

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

{% /tab %}

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

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

{% /tab %}

{% tab label="Commandline" %}

#Syntax: stop
rippled stop

{% /tab %}

{% /tabs %}

The request includes no parameters.

Response Format

An example of a successful response:

{% tabs %}

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

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

{% /tab %}

{% tab label="Commandline" %}

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

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

{% /tab %}

{% /tabs %}

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][].

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