mirror of
https://github.com/hashicorp/vault.git
synced 2025-11-28 14:11:10 +01:00
website: mostly complete API
This commit is contained in:
Mitchell Hashimoto
parent
3bec79d857
commit
138f84d80e
107
website/source/docs/http/sys-audit.html.md
Normal file
107
website/source/docs/http/sys-audit.html.md
Normal file
@ -0,0 +1,107 @@
|
|||||||
|
---
|
||||||
|
layout: "http"
|
||||||
|
page_title: "HTTP API: /sys/audit"
|
||||||
|
sidebar_current: "docs-http-audits-audits"
|
||||||
|
description: |-
|
||||||
|
The `/sys/audit` endpoint is used to enable and disable audit backends.
|
||||||
|
---
|
||||||
|
|
||||||
|
# /sys/audit
|
||||||
|
|
||||||
|
## GET
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt>Description</dt>
|
||||||
|
<dd>
|
||||||
|
Lists all the available policies.
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Method</dt>
|
||||||
|
<dd>GET</dd>
|
||||||
|
|
||||||
|
<dt>Parameters</dt>
|
||||||
|
<dd>
|
||||||
|
None
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Returns</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"file": {
|
||||||
|
"type: "file",
|
||||||
|
"description: "Store logs in a file",
|
||||||
|
"options": {
|
||||||
|
"path": "/var/log/file"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
## PUT
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt>Description</dt>
|
||||||
|
<dd>
|
||||||
|
Enable an audit backend.
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Method</dt>
|
||||||
|
<dd>PUT</dd>
|
||||||
|
|
||||||
|
<dt>URL</dt>
|
||||||
|
<dd>`/sys/audit/<name>`</dd>
|
||||||
|
|
||||||
|
<dt>Parameters</dt>
|
||||||
|
<dd>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<span class="param">type</span>
|
||||||
|
<span class="param-flags">required</span>
|
||||||
|
The type of the audit backend.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<span class="param">description</span>
|
||||||
|
<span class="param-flags">optional</span>
|
||||||
|
A description of the audit backend for operators.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<span class="param">options</span>
|
||||||
|
<span class="param-flags">optional</span>
|
||||||
|
An object of options to configure the backend. This is
|
||||||
|
dependent on the backend type. Please consult the documentation
|
||||||
|
for the backend type you intend to use.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Returns</dt>
|
||||||
|
<dd>`204` response code.
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
## DELETE
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt>Description</dt>
|
||||||
|
<dd>
|
||||||
|
Disable the given audit backend.
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Method</dt>
|
||||||
|
<dd>DELETE</dd>
|
||||||
|
|
||||||
|
<dt>URL</dt>
|
||||||
|
<dd>`/sys/audit/<name>`</dd>
|
||||||
|
|
||||||
|
<dt>Parameters</dt>
|
||||||
|
<dd>None
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Returns</dt>
|
||||||
|
<dd>`204` response code.
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
91
website/source/docs/http/sys-policy.html.md
Normal file
91
website/source/docs/http/sys-policy.html.md
Normal file
@ -0,0 +1,91 @@
|
|||||||
|
---
|
||||||
|
layout: "http"
|
||||||
|
page_title: "HTTP API: /sys/policy"
|
||||||
|
sidebar_current: "docs-http-auth-policy"
|
||||||
|
description: |-
|
||||||
|
The `/sys/policy` endpoint is used to manage ACL policies in Vault.
|
||||||
|
---
|
||||||
|
|
||||||
|
# /sys/policy
|
||||||
|
|
||||||
|
## GET
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt>Description</dt>
|
||||||
|
<dd>
|
||||||
|
Lists all the available policies.
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Method</dt>
|
||||||
|
<dd>GET</dd>
|
||||||
|
|
||||||
|
<dt>Parameters</dt>
|
||||||
|
<dd>
|
||||||
|
None
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Returns</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"policies": ["root", "deploy"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
## PUT
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt>Description</dt>
|
||||||
|
<dd>
|
||||||
|
Add or update a policy. Once a policy is updated, it takes effect
|
||||||
|
immediately to all associated users.
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Method</dt>
|
||||||
|
<dd>PUT</dd>
|
||||||
|
|
||||||
|
<dt>URL</dt>
|
||||||
|
<dd>`/sys/policy/<name>`</dd>
|
||||||
|
|
||||||
|
<dt>Parameters</dt>
|
||||||
|
<dd>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<span class="param">rules</span>
|
||||||
|
<span class="param-flags">required</span>
|
||||||
|
The policy document.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Returns</dt>
|
||||||
|
<dd>`204` respons code.
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
## DELETE
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt>Description</dt>
|
||||||
|
<dd>
|
||||||
|
Delete the policy with the given name. This will immediately
|
||||||
|
affect all associated users.
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Method</dt>
|
||||||
|
<dd>DELETE</dd>
|
||||||
|
|
||||||
|
<dt>URL</dt>
|
||||||
|
<dd>`/sys/policy/<name>`</dd>
|
||||||
|
|
||||||
|
<dt>Parameters</dt>
|
||||||
|
<dd>None
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Returns</dt>
|
||||||
|
<dd>`204` respons code.
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
38
website/source/docs/http/sys-renew.html.md
Normal file
38
website/source/docs/http/sys-renew.html.md
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
layout: "http"
|
||||||
|
page_title: "HTTP API: /sys/renew"
|
||||||
|
sidebar_current: "docs-http-lease-renew"
|
||||||
|
description: |-
|
||||||
|
The `/sys/renew` endpoint is used to renew secrets.
|
||||||
|
---
|
||||||
|
|
||||||
|
# /sys/renew
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt>Description</dt>
|
||||||
|
<dd>
|
||||||
|
Renew a secret, requesting to extend the lease.
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Method</dt>
|
||||||
|
<dd>PUT</dd>
|
||||||
|
|
||||||
|
<dt>URL</dt>
|
||||||
|
<dd>`/sys/renew/<lease id>`</dd>
|
||||||
|
|
||||||
|
<dt>Parameters</dt>
|
||||||
|
<dd>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<span class="param">increment</span>
|
||||||
|
<span class="param-flags">optional</span>
|
||||||
|
A requested amount of time in seconds to extend the lease.
|
||||||
|
This is advisory.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Returns</dt>
|
||||||
|
<dd>A secret structure.
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
29
website/source/docs/http/sys-revoke.html.md
Normal file
29
website/source/docs/http/sys-revoke.html.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
---
|
||||||
|
layout: "http"
|
||||||
|
page_title: "HTTP API: /sys/revoke"
|
||||||
|
sidebar_current: "docs-http-lease-revoke"
|
||||||
|
description: |-
|
||||||
|
The `/sys/revoke` endpoint is used to revoke secrets.
|
||||||
|
---
|
||||||
|
|
||||||
|
# /sys/revoke
|
||||||
|
|
||||||
|
<dl>
|
||||||
|
<dt>Description</dt>
|
||||||
|
<dd>
|
||||||
|
Revoke a secret immediately.
|
||||||
|
</dd>
|
||||||
|
|
||||||
|
<dt>Method</dt>
|
||||||
|
<dd>PUT</dd>
|
||||||
|
|
||||||
|
<dt>URL</dt>
|
||||||
|
<dd>`/sys/revoke/<lease id>`</dd>
|
||||||
|
|
||||||
|
<dt>Parameters</dt>
|
||||||
|
<dd>None</dd>
|
||||||
|
|
||||||
|
<dt>Returns</dt>
|
||||||
|
<dd>A `204` response code.
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
Loading…
x
Reference in New Issue
Block a user