Cluster get settings API

edit

Returns cluster-wide settings.

GET /_cluster/settings

Description

edit

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.

Query parameters

edit
flat_settings
(Optional, Boolean) If true, returns settings in flat format. Defaults to false.
include_defaults
(Optional, Boolean) If true, returns all default cluster settings. Defaults to false.
master_timeout
(Optional, time units) Specifies the period of time 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. Defaults to 30s.
timeout
(Optional, time units) Specifies the period of time to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.