Get security index settings Generally available

View as markdown
GET /_security/settings
Api key auth Basic auth Bearer auth

Get the user-configurable settings for the security internal index (.security and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes:

  • index.auto_expand_replicas
  • index.number_of_replicas

Required authorization

  • Cluster privileges: read_security

Query parameters

  • master_timeout string

    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.

    External documentation

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • security object Required

      Settings for the index used for most security configuration, including native realm users and roles configured with the API.

      Hide security attribute Show security attribute object
    • security-profile object Required

      Settings for the index used to store profile information.

      Hide security-profile attribute Show security-profile attribute object
    • security-tokens object Required

      Settings for the index used to store tokens.

      Hide security-tokens attribute Show security-tokens attribute object
GET /_security/settings 
GET /_security/settings 
resp = client.security.get_settings()
const response = await client.security.getSettings();
response = client.security.get_settings
$resp = $client->security()->getSettings();
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_security/settings"