Get index settings API

Returns setting information for an index.

GET /twitter/_settings

Request

GET /<index>/_settings

GET /<index>/_settings/<setting>

Path parameters

<index>

(Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.

Use a value of _all to retrieve information for all indices in the cluster.

<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.

expand_wildcards

(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Valid values are:

all
Expand to open and closed indices.
open
Expand only to open indices.
closed
Expand only to closed indices.
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 indices

The get settings API can be used to get settings for more than one index with a single call. To get settings for all indices you can use _all for <index>. Wildcard expressions are also supported. The following are some examples:

GET /twitter,kimchy/_settings

GET /_all/_settings

GET /log_2013_*/_settings

Filtering settings by name

The settings that are returned can be filtered with wildcard matching as follows:

GET /log_2013_-*/_settings/index.number_*