IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get index alias API Get index template API »
Elastic Docs ›Elasticsearch Guide [7.10] ›REST APIs ›Index APIs

Get index settings API

edit

Get index settings API

edit

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

edit

GET /<target>/_settings

GET /<target>/_settings/<setting>

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the view_index_metadata, monitor, or manage index privilege for the target data stream, index, or index alias.

Path parameters

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

edit
allow_no_indices

(Optional, Boolean) 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.

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 false, the request returns an error if it targets a missing or closed index. 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) 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. Defaults to 30s.

Examples

edit

Multiple data streams and indices

edit

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

edit

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

GET /log_2099_-*/_settings/index.number_*
« Get index alias API Get index template API »