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.

Create or Update Allow List API

Introduced 2.1

Creates or replaces the allow list configuration.

This API is reserved for a superadmin. Authenticate with an admin certificate rather than with a user name and password. For more information, see Access control for the API.

Endpoints

PUT /_plugins/_security/api/allowlist

Request body fields

The request body is required. It is a JSON object with the following fields.

Example request

PUT _plugins/_security/api/allowlist
{
  "enabled": true,
  "requests": {
    "/_cat/nodes": [
      "GET"
    ],
    "/_cat/indices": [
      "GET"
    ],
    "/_plugins/_security/whoami": [
      "GET"
    ]
  }
}

Example response

{
  "status": "OK",
  "message": "'config' updated."
}