mirror of
https://github.com/hashicorp/vault.git
synced 2025-09-06 22:41:08 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
41 lines
1.5 KiB
Plaintext
41 lines
1.5 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: /sys/step-down - HTTP API
|
|
description: The `/sys/step-down` endpoint causes the node to give up active status.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# `/sys/step-down`
|
|
|
|
@include 'alerts/restricted-root.mdx'
|
|
|
|
The `/sys/step-down` endpoint causes the node to give up active status.
|
|
|
|
## Step down leader
|
|
|
|
The step-down endpoint forces nodes to give up "active" status. If you
|
|
call the endpoint against a non-active node, for example, a DR or
|
|
performance standby node, Vault forwards the request to the active
|
|
node.
|
|
|
|
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
|
|
```
|