Link Search Menu Expand Document Documentation Menu

Patch Audit Configuration API

Introduced 1.0

Updates specified fields in the audit configuration. This method requires an operation, a path, and a value to complete a valid request. For details on using the PATCH method, see the Patching resources description at Wikipedia.

Using the PATCH method also requires a user to have a security configuration that includes admin certificates for encryption. To find out more about these certificates, see Configuring admin certificates.

Endpoints

PATCH /_plugins/_security/api/audit

Example request

PATCH _plugins/_security/api/audit
[
  {
    "op": "replace",
    "path": "/config/audit/enable_rest",
    "value": true
  }
]

Example response

{
  "status": "OK",
  "message": "No updates required"
}
HTTP/1.1 200 OK
content-type: application/json; charset=UTF-8
content-length: 45

Response body fields

The response body is a JSON object with the following fields.

Field Data type Description
status String The status of the request. A successful request returns OK.
message String A message describing the result of the operation.
350 characters left

Have a question? .

Want to contribute? or .