luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity
open-vault/website/source/docs/http/system/step-down.html.md
Seth Vargo 19b2b049c3
Redo docs for system backend 
This commit updates the API documentation for the system backend to
break things apart on a per-page basis and provide specific examples.
This pattern will give more flexibility for future documentation as
well.
2017-03-16 09:46:49 -07:00

1 KiB
Raw Blame History

layout page_title sidebar_current description
http /sys/step-down - HTTP API docs-http-system-step-down 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 Produces
PUT /sys/step-down 204 (empty body)

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    https://vault.rocks/v1/sys/step-down