/sys/step-down

[!IMPORTANT]
Documentation Update: Product documentation, which were located in this repository under /website, are now located in 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.

Restricted endpoint

Clients must call the API path from the root namespace.

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

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    http://127.0.0.1:8200/v1/sys/step-down