Add website docs

This commit is contained in:
Jeff Mitchell 2016-03-09 12:49:12 -05:00
parent d91d35b85a
commit b2a89bf47c
2 changed files with 40 additions and 0 deletions

View File

@ -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
<dl>
<dt>Description</dt>
<dd>
Revoke all secrets generated under a given prefix immediately. Unlike
`/sys/revoke-prefix`, this path ignores backend errors encountered during
revocation. This is <i>potentially very dangerous</i> and should only be
used in specific emergency situations where errors in the backend or the
connected backend service prevent normal revocation. <i>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.</i>
</dd>
<dt>Method</dt>
<dd>PUT</dd>
<dt>URL</dt>
<dd>`/sys/revoke-force/<path prefix>`</dd>
<dt>Parameters</dt>
<dd>None</dd>
<dt>Returns</dt>
<dd>A `204` response code.
</dd>
</dl>

View File

@ -98,6 +98,10 @@
<li<%= sidebar_current("docs-http-lease-revoke-prefix") %>>
<a href="/docs/http/sys-revoke-prefix.html">/sys/revoke-prefix</a>
</li>
<li<%= sidebar_current("docs-http-lease-revoke-force") %>>
<a href="/docs/http/sys-revoke-force.html">/sys/revoke-force</a>
</li>
</ul>
</li>