2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
2017-03-17 18:06:03 +00:00
|
|
|
|
layout: "api"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
page_title: "/sys/audit - HTTP API"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
|
sidebar_title: "<tt>/sys/audit</tt>"
|
|
|
|
|
|
sidebar_current: "api-http-system-audit/"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
description: |-
|
2017-09-21 21:14:40 +00:00
|
|
|
|
The `/sys/audit` endpoint is used to enable and disable audit devices.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# `/sys/audit`
|
|
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
The `/sys/audit` endpoint is used to list, enable, and disable audit devices.
|
|
|
|
|
|
Audit devices must be enabled before use, and more than one device may be
|
2017-03-15 06:40:33 +00:00
|
|
|
|
enabled at a time.
|
|
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
## List Enabled Audit Devices
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
This endpoint lists only the enabled audit devices (it does not list all
|
|
|
|
|
|
available audit devices).
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
|
- **`sudo` required** – This endpoint requires `sudo` capability in addition to
|
|
|
|
|
|
any path-specific capabilities.
|
|
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `GET` | `/sys/audit` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/audit
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
|
|
{
|
|
|
|
|
|
"file": {
|
|
|
|
|
|
"type": "file",
|
|
|
|
|
|
"description": "Store logs in a file",
|
|
|
|
|
|
"options": {
|
2018-09-20 22:55:20 +00:00
|
|
|
|
"file_path": "/var/log/vault.log"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
## Enable Audit Device
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
This endpoint enables a new audit device at the supplied path. The path can be a
|
2017-03-15 06:40:33 +00:00
|
|
|
|
single word name or a more complex, nested path.
|
|
|
|
|
|
|
|
|
|
|
|
- **`sudo` required** – This endpoint requires `sudo` capability in addition to
|
|
|
|
|
|
any path-specific capabilities.
|
|
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `PUT` | `/sys/audit/:path` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
- `path` `(string: <required>)` – Specifies the path in which to enable the audit
|
|
|
|
|
|
device. This is part of the request URL.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
|
- `description` `(string: "")` – Specifies a human-friendly description of the
|
2017-09-21 21:14:40 +00:00
|
|
|
|
audit device.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
|
- `options` `(map<string|string>: nil)` – Specifies configuration options to
|
2017-09-21 21:14:40 +00:00
|
|
|
|
pass to the audit device itself. This is dependent on the audit device type.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
- `type` `(string: <required>)` – Specifies the type of the audit device.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
2017-04-28 18:33:27 +00:00
|
|
|
|
Additionally, the following options are allowed in Vault open-source, but
|
|
|
|
|
|
relevant functionality is only supported in Vault Enterprise:
|
|
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
- `local` `(bool: false)` – Specifies if the audit device is a local only. Local
|
|
|
|
|
|
audit devices are not replicated nor (if a secondary) removed by replication.
|
2017-04-28 18:33:27 +00:00
|
|
|
|
|
2017-03-15 06:40:33 +00:00
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"type": "file",
|
|
|
|
|
|
"options": {
|
2018-09-20 22:55:20 +00:00
|
|
|
|
"file_path": "/var/log/vault/log"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
--request PUT \
|
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/audit/example-audit
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
## Disable Audit Device
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
This endpoint disables the audit device at the given path.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
|
- **`sudo` required** – This endpoint requires `sudo` capability in addition to
|
|
|
|
|
|
any path-specific capabilities.
|
|
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `DELETE` | `/sys/audit/:path` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
2017-09-21 21:14:40 +00:00
|
|
|
|
- `path` `(string: <required>)` – Specifies the path of the audit device to
|
2017-03-15 06:40:33 +00:00
|
|
|
|
delete. This is part of the request URL.
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
--request DELETE \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/audit/example-audit
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|