Get cluster-wide settings
- GET /_cluster/settings
By default, it returns only settings that have been explicitly defined.
- Cluster privileges:
monitor
Query Parameters
-
flat_settingsboolean · default: false If
true, returns settings in flat format.-
include_defaultsboolean · default: false If
true, also returns default values for all other cluster settings, reflecting the values in theelasticsearch.ymlfile of one of the nodes in the cluster. If the nodes in your cluster do not all have the same values in theirelasticsearch.ymlconfig files then the values returned by this API may vary from invocation to invocation and may not reflect the values that Elasticsearch uses in all situations. Use theGET _nodes/settingsAPI to fetch the settings for each individual node in your cluster.-
master_timeoutstring Duration · default: 30s Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
-
timeoutstring Duration · default: 30s Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
Response
-
persistentmap string to objectrequired -
The settings that persist after the cluster restarts.
-
transientmap string to objectrequired -
The settings that do not persist after the cluster restarts.
-
defaultsmap string to object -
The default setting values.