# /sys/config/auditing/request-headers

The `/sys/config/auditing` endpoint is used to configure auditing settings.

### Read all audited request headers

This endpoint lists the request headers that are configured to be audited.

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

| Method | Path                                   |
| ------ | -------------------------------------- |
| `GET`  | `/sys/config/auditing/request-headers` |

#### Sample request

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/config/auditing/request-headers
```

#### Sample response

```json
{
  "headers": {
    "X-Forwarded-For": {
      "hmac": true
    }
  }
}
```

### Read single audit request header

This endpoint lists the information for the given request header.

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

| Method | Path                                         |
| ------ | -------------------------------------------- |
| `GET`  | `/sys/config/auditing/request-headers/:name` |

#### Parameters

* `name` `(string: <required>)` – Specifies the name of the request header to query. This is specified as part of the URL.

#### Sample request

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/config/auditing/request-headers/my-header
```

#### Sample response

```json
{
  "X-Forwarded-For": {
    "hmac": true
  }
}
```

### Create/Update audit request header

This endpoint enables auditing of a header.

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

| Method | Path                                         |
| ------ | -------------------------------------------- |
| `POST` | `/sys/config/auditing/request-headers/:name` |

#### Parameters

* `hmac` `(bool: false)` – Specifies if this header's value should be HMAC'ed in the audit logs.

#### Sample payload

```json
{
  "hmac": true
}
```

#### Sample request

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/config/auditing/request-headers/my-header
```

### Delete audit request header

This endpoint disables auditing of the given request header.

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

| Method   | Path                                         |
| -------- | -------------------------------------------- |
| `DELETE` | `/sys/config/auditing/request-headers/:name` |

#### Sample request

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    http://127.0.0.1:8200/v1/sys/config/auditing/request-headers/my-header
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.enclaive.cloud/vault/api/system-backend/sys-config-auditing-request-headers.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.