Search + K

Command Palette

Search for a command to run...

Sign In

Get cluster-wide settings

GET /_cluster/settings
Copy endpoint

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

Required authorization

  • Cluster privileges: monitor

Parameters

query Query Parameters

Name Type
flat_settings

If true, returns settings in flat format.

boolean
include_defaults

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.

boolean
master_timeout

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.

type TypesDuration = string | "-1" | "0"
timeout

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

type TypesDuration = string | "-1" | "0"

Responses

200 application/json
{ persistent: { };transient: { };defaults?: { }; }