Get cluster-wide settings

  • GET /_cluster/settings
Auth

By default, it returns only settings that have been explicitly defined.

Read the reference documentation

Required authorization

Cluster privileges monitor

Query parameters

flat_settings boolean · default: false

If true, returns settings in flat format.

include_defaults boolean · default: false

If true, also returns default values for all other cluster settings, reflecting the values in the elasticsearch.yml file of one of the nodes in the cluster. If the nodes in your cluster do not all have the same values in their elasticsearch.yml config 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 the GET _nodes/settings API to fetch the settings for each individual node in your cluster.

master_timeout string · 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.

timeout string · 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

application/json
persistent map string to object required

The settings that persist after the cluster restarts.

transient map string to object required

The settings that do not persist after the cluster restarts.

defaults map string to object

The default setting values.