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.

Query Parameters

allow_no_indices boolean · default: true

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

expand_wildcards string ExpandWildcards · default: open

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

flat_settings boolean · default: false

If true, returns settings in flat format.

ignore_unavailable boolean · default: false

If false, the request returns an error if it targets a missing or closed index.

include_defaults boolean · default: false

If true, return all default settings in the response.

local boolean · default: false deprecated

If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

master_timeout string Duration · 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

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

Get index settings

Required authorization

Path Parameters

Query Parameters

Response

Required authorization

Path Parameters { index , name , }

Query Parameters { allow_no_indices , expand_wildcards , flat_settings , ignore_unavailable , include_defaults , local , master_timeout , }

Response

Path Parameters

Query Parameters