OpenSearch/docs/reference/indices/get-settings.asciidoc

[[indices-get-settings]]
=== Get index settings API
++++
<titleabbrev>Get index settings</titleabbrev>
++++

Returns setting information for an index.

[source,console]
--------------------------------------------------
GET /twitter/_settings
--------------------------------------------------
// TEST[setup:twitter]


[[get-index-settings-api-request]]
==== {api-request-title}

`GET /<index>/_settings`

`GET /<index>/_settings/<setting>`


[[get-index-settings-api-path-params]]
==== {api-path-parms-title}

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index]
+
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.


[[get-index-settings-api-query-params]]
==== {api-query-parms-title}

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
Defaults to `all`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-defaults]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]


[[get-index-settings-api-example]]
==== {api-examples-title}

===== 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:

[source,console]
--------------------------------------------------
GET /twitter,kimchy/_settings

GET /_all/_settings

GET /log_2013_*/_settings
--------------------------------------------------
// TEST[setup:twitter]
// TEST[s/^/PUT kimchy\nPUT log_2013_01_01\n/]

===== Filtering settings by name

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

[source,console]
--------------------------------------------------
GET /log_2013_-*/_settings/index.number_*
--------------------------------------------------
// TEST[continued]