diff --git a/website/source/docs/http/sys-revoke-force.html.md b/website/source/docs/http/sys-revoke-force.html.md new file mode 100644 index 0000000000..c8115ff277 --- /dev/null +++ b/website/source/docs/http/sys-revoke-force.html.md @@ -0,0 +1,36 @@ +--- +layout: "http" +page_title: "HTTP API: /sys/revoke-force" +sidebar_current: "docs-http-lease-revoke-force" +description: |- + The `/sys/revoke-force` endpoint is used to revoke secrets based on prefix while ignoring backend errors. +--- + +# /sys/revoke-force + +
+
Description
+
+ Revoke all secrets 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
+
PUT
+ +
URL
+
`/sys/revoke-force/`
+ +
Parameters
+
None
+ +
Returns
+
A `204` response code. +
+
diff --git a/website/source/layouts/http.erb b/website/source/layouts/http.erb index ac69d5651e..80a0b89431 100644 --- a/website/source/layouts/http.erb +++ b/website/source/layouts/http.erb @@ -98,6 +98,10 @@ > /sys/revoke-prefix + + > + /sys/revoke-force +