open-vault/website/source/api/system/audit.html.md

layout	page_title	sidebar_title	sidebar_current	description
api	/sys/audit - HTTP API	<code>/sys/audit</code>	api-http-system-audit/	The `/sys/audit` endpoint is used to enable and disable audit devices.

/sys/audit

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 enabled at a time.

List Enabled Audit Devices

This endpoint lists only the enabled audit devices (it does not list all available audit devices).

• sudo required – This endpoint requires sudo capability in addition to any path-specific capabilities.

Method	Path
GET	/sys/audit

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/audit

Sample Response

{
  "file": {
    "type": "file",
    "description": "Store logs in a file",
    "options": {
      "file_path": "/var/log/vault.log"
    }
  }
}

Enable Audit Device

This endpoint enables a new audit device at the supplied path. The path can be a 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
PUT	/sys/audit/:path

Parameters

• path (string: <required>) – Specifies the path in which to enable the audit device. This is part of the request URL.

• description (string: "") – Specifies a human-friendly description of the audit device.

• options (map<string|string>: nil) – Specifies configuration options to pass to the audit device itself. This is dependent on the audit device type.

• type (string: <required>) – Specifies the type of the audit device.

Additionally, the following options are allowed in Vault open-source, but relevant functionality is only supported in Vault Enterprise:

• 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.

Sample Payload

{
  "type": "file",
  "options": {
    "file_path": "/var/log/vault/log"
  }
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request PUT \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/audit/example-audit

Disable Audit Device

This endpoint disables the audit device at the given path.

• sudo required – This endpoint requires sudo capability in addition to any path-specific capabilities.

Method	Path
DELETE	/sys/audit/:path

Parameters

• path (string: <required>) – Specifies the path of the audit device to delete. This is part of the request URL.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    http://127.0.0.1:8200/v1/sys/audit/example-audit