You're viewing version 3.8 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Get Audit Configuration API

Introduced 1.0

Retrieves the audit logging and compliance configuration.

For details on using audit logging to track access to OpenSearch clusters, as well as information on further configurations, see Audit logs.

Endpoints

GET /_plugins/_security/api/audit

Example request

GET _plugins/_security/api/audit

Example response

The response is abbreviated here:

{
  "_readonly": [],
  ...
}

Response body fields

The _readonly field lists the configuration paths that cannot be modified. Changes to these paths result in a 409 error. The config field contains the current audit and compliance settings. For descriptions of the individual settings, see Update Audit Configuration API.