vault/website/source/docs/http/sys-config-auditing.html.md
2017-02-07 17:02:14 -05:00

2.1 KiB

layout, page_title, sidebar_current, description
layout page_title sidebar_current description
http HTTP API: /sys/config/auditing docs-http-config-auditing The `/sys/config/auditing` endpoint is used to configure auditing settings.

/sys/config/auditing/request-headers

GET

Description
List the request headers that are configured to be audited. _This endpoint requires `sudo` capability._
Method
GET
Parameters
None
Returns
```javascript
{
    "headers":{
        "X-Forwarded-For": {
            "hmac":true
        }
    }
}
```

/sys/config/auditing/request-headers/

GET

Description
List the information for the given request header. _This endpoint requires `sudo` capability._
Method
GET
URL
`/sys/config/auditing/request-headers/`
Parameters
None
Returns
```javascript
{
    "X-Forwarded-For":{
        "hmac":true
    }
}
```

PUT

Description
Enable auditing of a header. _This endpoint requires `sudo` capability._
Method
PUT
URL
`/sys/config/auditing/request-headers/`
Parameters
  • hmac optional Bool, if this header's value should be hmac'ed in the audit logs. Defaults to false.
Returns
`204` response code.

DELETE

Description
Disable auditing of the given request header. _This endpoint requires `sudo` capability._
Method
DELETE
URL
`/sys/config/auditing/request-headers/`
Parameters
None
Returns
`204` response code.