Update Watcher index settings Generally available

PUT /_watcher/settings

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.

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

    External documentation
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
curl \
 --request PUT 'http://api.example.com/_watcher/settings' \
 --header "Content-Type: application/json" \
 --data '"{\n  \"index.auto_expand_replicas\": \"0-4\"\n}"'
Request example
{
  "index.auto_expand_replicas": "0-4"
}