You're viewing version 1.1 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Cluster settings
Introduced 1.0
The cluster settings operation lets you check the current settings for your cluster, review default settings, and change settings. When you update a setting using the API, OpenSearch applies it to all nodes in the cluster.
Examples
GET _cluster/settings?include_defaults=true
PUT _cluster/settings
{
"persistent": {
"action": {
"auto_create_index": false
}
}
}
Path and HTTP methods
GET _cluster/settings
PUT _cluster/settings
URL parameters
All cluster settings parameters are optional.
| Parameter | Type | Description |
|---|---|---|
| flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "cluster": { "max_shards_per_node": 500 } is "cluster.max_shards_per_node": "500". |
| include_defaults (GET only) | Boolean | Whether to include default settings as part of the response. This parameter is useful for identifying the names and current values of settings you want to update. |
| master_timeout | Time | The amount of time to wait for a response from the master node. Default is 30 seconds. |
| timeout (PUT only) | Time | The amount of time to wait for a response from the cluster. Default is 30 seconds. |
Request body
The GET operation has no request body options.
For a PUT operation, the request body must contain transient or persistent, along with the setting you want to update:
PUT _cluster/settings
{
"persistent": {
"cluster": {
"max_shards_per_node": 500
}
}
}
For more information about transient settings, persistent settings, and precedence, see OpenSearch configuration.
Response
{
"acknowledged": true,
"persistent": {
"cluster": {
"max_shards_per_node": "500"
}
},
"transient": {}
}