luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity
open-vault/website/source/docs/http/system/revoke-force.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.4 KiB
Raw Blame History

layout page_title sidebar_current description
http /sys/revoke-force - HTTP API docs-http-system-revoke-force The `/sys/revoke-force` endpoint is used to revoke secrets or tokens based on prefix while ignoring backend errors.

/sys/revoke-force

The /sys/revoke-force endpoint is used to revoke secrets or tokens based on prefix while ignoring backend errors.

Revoke Force

This endpoint revokes all secrets or tokens generated under a given prefix immediately. Unlike /sys/revoke-prefix, this path ignores backend errors encountered during revocation. This is potentially very dangerous and should only be used in specific emergency situations where errors in the backend or the connected backend service prevent normal revocation.

By ignoring these errors, Vault abdicates responsibility for ensuring that the issued credentials or secrets are properly revoked and/or cleaned up. Access to this endpoint should be tightly controlled.

Method Path Produces
PUT /sys/revoke-force/:prefix 204 (empty body)

Parameters

  • prefix (string: <required>) – Specifies the prefix to revoke. This is specified as part of the URL.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    https://vault.rocks/v1/sys/revoke-force/aws/creds