A newer version is available. For the latest information, see the
current release documentation.
Cluster get settings API
editCluster get settings API
editReturns cluster-wide settings.
GET /_cluster/settings
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
monitorormanagecluster privilege to use this API.
Request
editGET /_cluster/settings
Description
editBy 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 tofalse. -
include_defaults -
(Optional, Boolean) If
true, returns all default cluster settings. Defaults tofalse. -
master_timeout -
(Optional, time units)
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. Defaults to
30s. -
timeout -
(Optional, time units)
Period to wait for a response. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s.