› › ›

Cluster get settings API

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

If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.

Request

GET /_cluster/settings

Description

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

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.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-get-settings.html