Update the cluster settings

PUT /_cluster/settings

Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in elasticsearch.yml.

Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value.

If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) elasticsearch.yml setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or elasticsearch.yml setting. However, a change to an elasticsearch.yml setting will not override a defined transient or persistent setting.

TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use elasticsearch.yml for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes.

WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.

More about Elastic Stack settings

Query Parameters

Request

Response

application/json

Examples

An example of a persistent update.

Request Console 1 / 8 languages

Console Kibana Dev Tools

PUT /_cluster/settings
{
  "persistent" : {
    "indices.recovery.max_bytes_per_sec" : "50mb"
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.cluster.putSettings({
  persistent: {
    "indices.recovery.max_bytes_per_sec": "50mb",
  },
});

Python Elasticsearch Python Client

resp = client.cluster.put_settings(
    persistent={
        "indices.recovery.max_bytes_per_sec": "50mb"
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_cluster/settings" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "persistent": {
      "indices.recovery.max_bytes_per_sec": "50mb"
    }
  }'

Java Elasticsearch Java Client

client.cluster().putSettings(p -> p
    .persistent("indices.recovery.max_bytes_per_sec", JsonData.fromJson("\"50mb\""))
);

C# Elasticsearch .NET Client

var response = await client.Cluster
    .PutSettingsAsync(d1 => d1
        .Persistent(new Dictionary<string, object>()
        {
            { "indices.recovery.max_bytes_per_sec", "50mb" }
        })
    );

PHP Elasticsearch PHP Client

$resp = $client->cluster()->putSettings([
    "body" => [
        "persistent" => [
            "indices.recovery.max_bytes_per_sec" => "50mb",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.cluster.put_settings(
  body: {
    "persistent": {
      "indices.recovery.max_bytes_per_sec": "50mb"
    }
  }
)

Response

No example

PUT /_cluster/settings to update the action.auto_create_index setting. The setting accepts a comma-separated list of patterns that you want to allow or you can prefix each pattern with + or - to indicate whether it should be allowed or blocked. In this example, the auto-creation of indices called my-index-000001 or index10 is allowed, the creation of indices that match the pattern index1* is blocked, and the creation of any other indices that match the ind* pattern is allowed. Patterns are matched in the order specified.

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /_cluster/settings
{
  "persistent": {
    "action.auto_create_index": "my-index-000001,index10,-index1*,+ind*" 
  }
}

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_cluster/settings" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "persistent": {
    "action.auto_create_index": "my-index-000001,index10,-index1*,+ind*" 
  }
}'

Response

No example

Query Parameters { flat_settings , master_timeout , timeout , }

Request { persistent , transient , }

Response

Query Parameters

Request