This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Cluster allocation explain API Cluster health API »

› › ›

Cluster get settings API

edit

Cluster get settings API

edit

Returns 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 or manage cluster privilege to use this API.

Request

edit

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 default cluster settings from the local node. Defaults to false.
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.

« Cluster allocation explain API Cluster health API »