IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Cluster Get Settings
editCluster Get Settings
editReturns cluster-wide settings.
GET /_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
. -
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
. -
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
.