Get security index settings

GET /_security/settings

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 privileges

Cluster privileges read_security

Query parameters

master_timeout string · default: 30s: 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.

Response

application/json

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

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_security/settings

JavaScript Elasticsearch JavaScript Client

const response = await client.security.getSettings();

Python Elasticsearch Python Client

resp = client.security.get_settings()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_security/settings" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().getSettings(g -> g);

C# Elasticsearch .NET Client

var response = await client.Security.GetSettingsAsync();

PHP Elasticsearch PHP Client

$resp = $client->security()->getSettings();

Ruby Elasticsearch Ruby Client

response = client.security.get_settings

Response

{
  "security": {
    "index": {}
  },
  "security-profile": {
    "index": {}
  },
  "security-tokens": {
    "index": {}
  }
}

Generated from the API spec