Get index settings API
Returns setting information for one or more indices. For data streams, the API returns setting information for the stream’s backing indices.
GET /my-index-000001/_settings
Request
GET /<target>/_settings
GET /<target>/_settings/<setting>
Path parameters
<target>
(Optional, string) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*
) are supported.
To target all data streams and indices in a cluster, omit this parameter or use _all
or *
.
<setting>
(Optional, string) Comma-separated list or wildcard expression of setting names used to limit the request.
Query parameters
allow_no_indices
(Optional, boolean) If true
, the request does not return an error if a wildcard expression or _all
value retrieves only missing or closed indices.
This parameter also applies to index aliases that point to a missing or closed index.
Defaults to true
.
expand_wildcards
(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Multiple values are accepted when separated by a comma, as in open,hidden
. Valid values are:
all
Expand to open and closed indices, including hidden indices.
open
Expand only to open indices.
closed
Expand only to closed indices.
hidden
Expansion of wildcards will include hidden indices. Must be combined with
open
,closed
, or both.none
Wildcard expressions are not accepted.
Defaults to all
.
flat_settings
(Optional, boolean) If true
, returns settings in flat format. Defaults to false
.
include_defaults
(Optional, string) If true
, return all default settings in the response. Defaults to false
.
ignore_unavailable
(Optional, boolean) If true
, missing or closed indices are not included in the response. Defaults to false
.
local
(Optional, boolean) If true
, the request retrieves information from the local node only. Defaults to false
, which means information is retrieved from the master node.
master_timeout
(Optional, time units) Specifies the period of time 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. Defaults to 30s
.
Examples
Multiple data streams and indices
The get settings API can be used to get settings for more than one data stream or index with a single call. To get settings for all indices in a cluster, you can use _all
or *
for <target>
. Wildcard expressions are also supported. The following are some examples:
GET /my-index-000001,my-index-000002/_settings
GET /_all/_settings
GET /log_2099_*/_settings
Filtering settings by name
The settings that are returned can be filtered with wildcard matching as follows:
GET /log_2099_-*/_settings/index.number_*