Update security index settings | Elasticsearch API documentation

Query parameters

master_timeoutstring
The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
Values are -1 or 0.
timeoutstring
The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
Values are -1 or 0.

application/json

BodyRequired

securityobject
Hide security attribute Show security attribute object
- indexobject
  Index settings
security-profileobject
Hide security-profile attribute Show security-profile attribute object
- indexobject
  Index settings
security-tokensobject
Hide security-tokens attribute Show security-tokens attribute object
- indexobject
  Index settings

Responses

200 application/json
Hide response attribute Show response attribute object
- acknowledgedboolean Required

PUT /_security/settings

PUT /_security/settings
{
    "security": {
        "index.auto_expand_replicas": "0-all"
    },
    "security-tokens": {
        "index.auto_expand_replicas": "0-all"
    },
    "security-profile": {
        "index.auto_expand_replicas": "0-all"
    }
}

resp = client.security.update_settings(
    security={
        "index.auto_expand_replicas": "0-all"
    },
    security-tokens={
        "index.auto_expand_replicas": "0-all"
    },
    security-profile={
        "index.auto_expand_replicas": "0-all"
    },
)

const response = await client.security.updateSettings({
  security: {
    "index.auto_expand_replicas": "0-all",
  },
  "security-tokens": {
    "index.auto_expand_replicas": "0-all",
  },
  "security-profile": {
    "index.auto_expand_replicas": "0-all",
  },
});

response = client.security.update_settings(
  body: {
    "security": {
      "index.auto_expand_replicas": "0-all"
    },
    "security-tokens": {
      "index.auto_expand_replicas": "0-all"
    },
    "security-profile": {
      "index.auto_expand_replicas": "0-all"
    }
  }
)

$resp = $client->security()->updateSettings([
    "body" => [
        "security" => [
            "index.auto_expand_replicas" => "0-all",
        ],
        "security-tokens" => [
            "index.auto_expand_replicas" => "0-all",
        ],
        "security-profile" => [
            "index.auto_expand_replicas" => "0-all",
        ],
    ],
]);

curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"security":{"index.auto_expand_replicas":"0-all"},"security-tokens":{"index.auto_expand_replicas":"0-all"},"security-profile":{"index.auto_expand_replicas":"0-all"}}' "$ELASTICSEARCH_URL/_security/settings"

Request example

Run `PUT /_security/settings` to modify the security settings.

{
    "security": {
        "index.auto_expand_replicas": "0-all"
    },
    "security-tokens": {
        "index.auto_expand_replicas": "0-all"
    },
    "security-profile": {
        "index.auto_expand_replicas": "0-all"
    }
}