IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Cluster allocation explain API Cluster health API »

› › ›

Cluster get settings API

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Cluster get settings API

edit

Returns cluster-wide settings.

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 all default cluster settings. Defaults to false.
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.

« Cluster allocation explain API Cluster health API »