mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
27878a78b5
If `include_defaults` is `true` the API returns the default settings from the node handling the API request.
43 lines
1.1 KiB
Text
43 lines
1.1 KiB
Text
[[cluster-get-settings]]
|
|
=== Cluster get settings API
|
|
++++
|
|
<titleabbrev>Cluster get settings</titleabbrev>
|
|
++++
|
|
|
|
Returns cluster-wide settings.
|
|
|
|
[source,console]
|
|
----
|
|
GET /_cluster/settings
|
|
----
|
|
|
|
[[cluster-get-settings-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `monitor` or
|
|
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[cluster-get-settings-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`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::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
|
|
|
`include_defaults`::
|
|
(Optional, Boolean) If `true`, returns default cluster settings from the local node.
|
|
Defaults to `false`.
|
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|