New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create or update watch API Get Watcher index settings »
Elastic Docs ›Elasticsearch Guide [8.14] ›REST APIs ›Watcher APIs

Update Watcher index settings

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Update Watcher index settings

edit

This API allows a user to modify the settings for the Watcher internal index (.watches). Only a subset of settings are allowed to by modified. This includes:

  • index.auto_expand_replicas
  • index.number_of_replicas

An example of modifying the Watcher settings:

PUT /_watcher/watch/test_watch
{
  "trigger": {
    "schedule": {
      "hourly": {
        "minute": [ 0, 5 ]
        }
      }
  },
  "input": {
    "simple": {
      "payload": {
        "send": "yes"
      }
    }
  },
  "condition": {
    "always": {}
  }
}
Copy as curlTry in Elastic 
response = client.watcher.update_settings(
  body: {
    'index.auto_expand_replicas' => '0-4'
  }
)
puts response
PUT /_watcher/settings
{
  "index.auto_expand_replicas": "0-4"
}
Copy as curlTry in Elastic 

The configurable settings can be retrieved using the Get Watcher index settings API.

« Create or update watch API Get Watcher index settings »
Was this helpful?
Feedback