Cluster get settings API
editCluster get settings API
editReturns cluster-wide settings.
resp = client.cluster.get_settings() print(resp)
response = client.cluster.get_settings puts response
const response = await client.cluster.getSettings(); console.log(response);
GET /_cluster/settings
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
monitor
ormanage
cluster 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 default cluster settings from the local node. Defaults tofalse
. -
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout.