open-vault/website/source/docs/http/system/rotate.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

951 B

layout page_title sidebar_current description
http /sys/rotate - HTTP API docs-http-system-rotate The `/sys/rotate` endpoint is used to rotate the encryption key.

/sys/rotate

The /sys/rotate endpoint is used to rotate the encryption key.

Rotate Encryption Key

This endpoint triggers a rotation of the backend encryption key. This is the key that is used to encrypt data written to the storage backend, and is not provided to operators. This operation is done online. Future values are encrypted with the new key, while old values are decrypted with previous encryption keys.

Method Path Produces
PUT /sys/rotate 204 (empty body)

Sample Request

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