open-vault/website/content/api-docs/system/step-down.mdx
Jim Kalafut 75caf59093
Replace docs references to PUT with POST (#14270)
The operations are handled identically, but ~85% of the references were
POST, and having a mix of PUT and POST was a source of questions.

A subsequent commit will update the internal use of "PUT" such as by
the API client and -output-curl-string.
2022-02-25 06:52:24 -08:00

32 lines
899 B
Plaintext

---
layout: api
page_title: /sys/step-down - HTTP API
description: The `/sys/step-down` endpoint causes the node to give up active status.
---
# `/sys/step-down`
The `/sys/step-down` endpoint causes the node to give up active status.
## Step Down Leader
This endpoint forces the node to give up active status. If the node does not
have active status, this endpoint does nothing. Note that the node will sleep
for ten seconds before attempting to grab the active lock again, but if no
standby nodes grab the active lock in the interim, the same node may become the
active node again. Requires a token with `root` policy or `sudo` capability on
the path.
| Method | Path |
| :----- | :--------------- |
| `POST` | `/sys/step-down` |
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/sys/step-down
```