mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-21 04:05:49 +00:00
7645140477
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.
96 lines
1.6 KiB
Markdown
96 lines
1.6 KiB
Markdown
---
|
|
html: stop.html
|
|
parent: server-control-methods.html
|
|
seo:
|
|
description: Shut down the rippled server.
|
|
labels:
|
|
- Core Server
|
|
---
|
|
# stop
|
|
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Stop.cpp "Source")
|
|
|
|
Gracefully shuts down the server.
|
|
|
|
*The `stop` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
|
|
|
|
### Request Format
|
|
An example of the request format:
|
|
|
|
{% tabs %}
|
|
|
|
{% tab label="WebSocket" %}
|
|
```json
|
|
{
|
|
"id": 0,
|
|
"command": "stop"
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="JSON-RPC" %}
|
|
```json
|
|
{
|
|
"method": "stop",
|
|
"params": [
|
|
{}
|
|
]
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="Commandline" %}
|
|
```sh
|
|
#Syntax: stop
|
|
rippled stop
|
|
```
|
|
{% /tab %}
|
|
|
|
{% /tabs %}
|
|
|
|
The request includes no parameters.
|
|
|
|
### Response Format
|
|
|
|
An example of a successful response:
|
|
|
|
{% tabs %}
|
|
|
|
{% tab label="JSON-RPC" %}
|
|
```json
|
|
{
|
|
"result" : {
|
|
"message" : "ripple server stopping",
|
|
"status" : "success"
|
|
}
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="Commandline" %}
|
|
```json
|
|
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="/docs/_snippets/common-links.md" /%}
|