luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity
open-vault/website/source/docs/http/sys-audit.html.md
Jeff Mitchell 85c51fd861 Update website docs to indicate sudo being required for auth/audit 
endpoints.
2016-09-19 12:10:08 -04:00

1.9 KiB
Raw Blame History

layout page_title sidebar_current description
http HTTP API: /sys/audit docs-http-audits-audits The `/sys/audit` endpoint is used to enable and disable audit backends.

/sys/audit

GET

Description
List the mounted audit backends. _This endpoint requires `sudo` capability._
Method
GET
Parameters
None
Returns
```javascript
{
  "file": {
    "type: "file",
    "description: "Store logs in a file",
    "options": {
      "path": "/var/log/file"
    }
  }
}
```

PUT

Description
Enable an audit backend. _This endpoint requires `sudo` capability._
Method
PUT
URL
`/sys/audit/`
Parameters
  • type required The type of the audit backend.
  • description optional A description of the audit backend for operators.
  • options optional 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.
Returns
`204` response code.

DELETE

Description
Disable the given audit backend. _This endpoint requires `sudo` capability._
Method
DELETE
URL
`/sys/audit/`
Parameters
None
Returns
`204` response code.