Update security index settings

PUT /_security/settings

Auth

Update the user-configurable settings for the security internal index (.security and associated indices). Only a subset of settings are allowed to be modified. This includes index.auto_expand_replicas and index.number_of_replicas.

Note

If index.auto_expand_replicas is set, index.number_of_replicas will be ignored during updates.

If a specific index is not in use on the system and settings are provided for it, the request will be rejected. This API does not yet support configuring the settings for indices before they are in use.

Required authorization

Cluster privileges manage_security

Query parameters

master_timeout string · default: 30s: 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.
timeout string: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Reference

Request body

security object: Settings for the index used for most security configuration, including native realm users and roles configured with the API.
security-profile object: Settings for the index used to store profile information.
security-tokens object: Settings for the index used to store tokens.

Response

application/json

acknowledged boolean required

Examples

Request Console 1 / 8 languages

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

Console Kibana Dev Tools

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"
        }      
    }
}

JavaScript Elasticsearch JavaScript Client

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",
    },
  },
});

Python Elasticsearch Python Client

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"
        }
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_security/settings" \
  -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"
      }
    }
  }'

Java Elasticsearch Java Client

client.security().updateSettings(u -> u
    .security(s -> s
        .index(i -> i
            .otherSettings(Map.of())
            .autoExpandReplicas("0-all")
        )
    )
    .securityProfile(s -> s
        .index(i -> i
            .otherSettings(Map.of())
            .autoExpandReplicas("0-all")
        )
    )
    .securityTokens(s -> s
        .index(i -> i
            .otherSettings(Map.of())
            .autoExpandReplicas("0-all")
        )
    )
);

C# Elasticsearch .NET Client

var response = await client.Security
    .UpdateSettingsAsync(d1 => d1
        .Security(d2 => d2
            .Index(d3 => d3
                .AutoExpandReplicas("0-all")
            )
        )
        .SecurityProfile(d2 => d2
            .Index(d3 => d3
                .AutoExpandReplicas("0-all")
            )
        )
        .SecurityTokens(d2 => d2
            .Index(d3 => d3
                .AutoExpandReplicas("0-all")
            )
        )
    );

PHP Elasticsearch PHP Client

$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",
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

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"
      }
    }
  }
)

Response

{
  "acknowledged": false
}

Generated from the API spec