2013-08-28 19:24:34 -04:00
|
|
|
[[indices-get-settings]]
|
2019-08-26 08:57:00 -04:00
|
|
|
=== Get index settings API
|
|
|
|
|
++++
|
|
|
|
|
<titleabbrev>Get index settings</titleabbrev>
|
|
|
|
|
++++
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-08-26 08:57:00 -04:00
|
|
|
Returns setting information for an index.
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2013-08-28 19:24:34 -04:00
|
|
|
--------------------------------------------------
|
2016-09-01 13:05:22 -04:00
|
|
|
GET /twitter/_settings
|
2013-08-28 19:24:34 -04:00
|
|
|
--------------------------------------------------
|
2016-09-01 13:05:22 -04:00
|
|
|
// TEST[setup:twitter]
|
2014-01-05 17:06:02 -05:00
|
|
|
|
|
|
|
|
|
2019-08-26 08:57:00 -04:00
|
|
|
[[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::{docdir}/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::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
|
2020-02-24 05:57:32 -05:00
|
|
|
+
|
|
|
|
|
Defaults to `true`.
|
2019-08-26 08:57:00 -04:00
|
|
|
|
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
|
|
|
|
|
+
|
|
|
|
|
Defaults to `all`.
|
|
|
|
|
|
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
|
|
|
|
|
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-defaults]
|
|
|
|
|
|
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
|
|
|
|
|
|
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
|
|
|
|
|
|
|
|
|
|
include::{docdir}/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>`.
|
2014-01-05 17:06:02 -05:00
|
|
|
Wildcard expressions are also supported. The following are some examples:
|
|
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2014-01-05 17:06:02 -05:00
|
|
|
--------------------------------------------------
|
2016-09-01 13:05:22 -04:00
|
|
|
GET /twitter,kimchy/_settings
|
2014-01-05 17:06:02 -05:00
|
|
|
|
2016-09-01 13:05:22 -04:00
|
|
|
GET /_all/_settings
|
2014-01-05 17:06:02 -05:00
|
|
|
|
2016-09-01 13:05:22 -04:00
|
|
|
GET /log_2013_*/_settings
|
2014-01-05 17:06:02 -05:00
|
|
|
--------------------------------------------------
|
2016-09-01 13:05:22 -04:00
|
|
|
// TEST[setup:twitter]
|
|
|
|
|
// TEST[s/^/PUT kimchy\nPUT log_2013_01_01\n/]
|
2014-01-05 17:06:02 -05:00
|
|
|
|
2019-08-26 08:57:00 -04:00
|
|
|
===== Filtering settings by name
|
2014-01-05 17:06:02 -05:00
|
|
|
|
2015-10-02 10:43:53 -04:00
|
|
|
The settings that are returned can be filtered with wildcard matching
|
|
|
|
|
as follows:
|
2014-01-05 17:06:02 -05:00
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2014-01-05 17:06:02 -05:00
|
|
|
--------------------------------------------------
|
2017-05-01 13:56:39 -04:00
|
|
|
GET /log_2013_-*/_settings/index.number_*
|
2014-01-05 17:06:02 -05:00
|
|
|
--------------------------------------------------
|
2020-02-24 05:57:32 -05:00
|
|
|
// TEST[continued]
|
