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.

OpenSearch Dashboards Dev Tools do not currently support the PATCH method. You can use cURL, Postman, or another alternative process to update the configuration using this method. To follow the GitHub issue for support of the PATCH method in Dashboards, see issue #2343.

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.