Get index settings

GET /{index}/_settings/{name}
GET /{index}/_settings
GET /_settings/{name}
GET /_settings

Get setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices.

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

Path parameters

Query parameters

Response

application/json

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getSettings({
  index: "_all",
  expand_wildcards: "all",
  filter_path: "*.settings.index.*.slowlog",
});

Python Elasticsearch Python Client

resp = client.indices.get_settings(
    index="_all",
    expand_wildcards="all",
    filter_path="*.settings.index.*.slowlog",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

C# Elasticsearch .NET Client

var response = await client.Indices
    .GetSettingsAsync(d1 => d1
        .Indices(new[] { "_all" })
        .ExpandWildcards(ExpandWildcard.All)
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->getSettings([
    "index" => "_all",
    "expand_wildcards" => "all",
    "filter_path" => "*.settings.index.*.slowlog",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get_settings(
  index: "_all",
  expand_wildcards: "all",
  filter_path: "*.settings.index.*.slowlog"
)

Response

No example