elasticsearch/docs/reference/cluster/get-settings.asciidoc

[[cluster-get-settings]]
=== Cluster get settings API
++++
<titleabbrev>Cluster get settings</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs].
--

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-ref-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-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]