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

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

/sys/revoke-prefix

The /sys/revoke-prefix endpoint is used to revoke secrets or tokens based on prefix.

Revoke Prefix

This endpoint revokes all secrets (via a lease ID prefix) or tokens (via the tokens' path property) generated under a given prefix immediately. This requires sudo capability and access to it should be tightly controlled as it can be used to revoke very large numbers of secrets/tokens at once.

Method Path Produces
PUT /sys/revoke-prefix/: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-prefix/aws/creds