Update Watcher index settings

PUT /_watcher/settings

Auth

Update settings for the Watcher internal index (.watches). Only a subset of settings can be modified. This includes index.auto_expand_replicas, index.number_of_replicas, index.routing.allocation.exclude.*, index.routing.allocation.include.* and index.routing.allocation.require.*. Modification of index.routing.allocation.include._tier_preference is an exception and is not allowed as the Watcher shards must always be in the data_content tier.

Required authorization

Cluster privileges manage_watcher

Query parameters

master_timeout string · default: 30s: The 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.
timeout string: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Reference

Request body

index.auto_expand_replicas string
index.number_of_replicas number

Response

application/json

acknowledged boolean required

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT /_watcher/settings
{
  "index.auto_expand_replicas": "0-4"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.watcher.updateSettings({
  "index.auto_expand_replicas": "0-4",
});

Python Elasticsearch Python Client

resp = client.watcher.update_settings(
    index_auto_expand_replicas="0-4",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_watcher/settings" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "index.auto_expand_replicas": "0-4"
  }'

Java Elasticsearch Java Client

client.watcher().updateSettings(u -> u
    .indexAutoExpandReplicas("0-4")
);

PHP Elasticsearch PHP Client

$resp = $client->watcher()->updateSettings([
    "body" => [
        "index.auto_expand_replicas" => "0-4",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.watcher.update_settings(
  body: {
    "index.auto_expand_replicas": "0-4"
  }
)

Response

{
  "acknowledged": false
}

Generated from the API spec

Required authorization

Query parameters

Request body { }

Response

Request body