2018-07-02 13:25:17 -04:00
|
|
|
[[cluster-get-settings]]
|
2019-10-22 13:27:31 -04:00
|
|
|
=== Cluster get settings API
|
|
|
|
|
++++
|
|
|
|
|
<titleabbrev>Cluster get settings</titleabbrev>
|
|
|
|
|
++++
|
2018-07-02 13:25:17 -04:00
|
|
|
|
2019-08-13 08:22:36 -04:00
|
|
|
Returns cluster-wide settings.
|
|
|
|
|
|
|
|
|
|
`GET /_cluster/settings`
|
|
|
|
|
|
|
|
|
|
[[cluster-get-settings-api-desc]]
|
|
|
|
|
==== {api-description-title}
|
|
|
|
|
|
|
|
|
|
By default, this API call only returns settings that have been explicitly
|
|
|
|
|
defined, but can also include the default settings by calling the
|
|
|
|
|
`include_defaults` parameter.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[[cluster-get-settings-api-query-params]]
|
|
|
|
|
==== {api-query-parms-title}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
|
|
|
|
|
|
|
|
|
`include_defaults`::
|
|
|
|
|
(Optional, boolean) If `true`, returns all default cluster settings.
|
|
|
|
|
Defaults to `false`.
|
|
|
|
|
|
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
