Update Watcher index settings Generally available

PUT /_watcher/settings
Api key auth Basic auth Bearer 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

    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.

    Values are -1 or 0.

  • 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.

    Values are -1 or 0.

application/json

Body Required

  • index.auto_expand_replicas string
  • index.number_of_replicas number

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • acknowledged boolean Required
PUT /_watcher/settings 
PUT /_watcher/settings { "index.auto_expand_replicas": "0-4" }
resp = client.watcher.update_settings( index.auto_expand_replicas="0-4", )
const response = await client.watcher.updateSettings({ "index.auto_expand_replicas": "0-4", });
response = client.watcher.update_settings( body: { "index.auto_expand_replicas": "0-4" } )
$resp = $client->watcher()->updateSettings([ "body" => [ "index.auto_expand_replicas" => "0-4", ], ]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"index.auto_expand_replicas":"0-4"}' "$ELASTICSEARCH_URL/_watcher/settings"
Request example 
{ "index.auto_expand_replicas": "0-4" }