open-vault/website/content/api-docs/system/step-down.mdx
Jeff Escalante ec620a7765
Implement MDX Remote (#10581)
* implement mdx remote

* fix an unfenced code block

* fix partials path

Co-authored-by: Jim Kalafut <jkalafut@hashicorp.com>
2020-12-17 16:53:33 -05:00

33 lines
941 B
Plaintext

---
layout: api
page_title: /sys/step-down - HTTP API
sidebar_title: <code>/sys/step-down</code>
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 |
| :----- | :--------------- |
| `PUT` | `/sys/step-down` |
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request PUT \
http://127.0.0.1:8200/v1/sys/step-down
```