Get security index settings

GET /_security/settings

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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

Response

application/json

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

No example