› › ›

Update Watcher index settings

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:

resp = client.watcher.put_watch(
    id="test_watch",
    trigger={
        "schedule": {
            "hourly": {
                "minute": [
                    0,
                    5
                ]
            }
        }
    },
    input={
        "simple": {
            "payload": {
                "send": "yes"
            }
        }
    },
    condition={
        "always": {}
    },
)
print(resp)

const response = await client.watcher.putWatch({
  id: "test_watch",
  trigger: {
    schedule: {
      hourly: {
        minute: [0, 5],
      },
    },
  },
  input: {
    simple: {
      payload: {
        send: "yes",
      },
    },
  },
  condition: {
    always: {},
  },
});
console.log(response);

PUT /_watcher/watch/test_watch
{
  "trigger": {
    "schedule": {
      "hourly": {
        "minute": [ 0, 5 ]
        }
      }
  },
  "input": {
    "simple": {
      "payload": {
        "send": "yes"
      }
    }
  },
  "condition": {
    "always": {}
  }
}

resp = client.perform_request(
    "PUT",
    "/_watcher/settings",
    headers={"Content-Type": "application/json"},
    body={
        "index.auto_expand_replicas": "0-4"
    },
)
print(resp)

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

const response = await client.transport.request({
  method: "PUT",
  path: "/_watcher/settings",
  body: {
    "index.auto_expand_replicas": "0-4",
  },
});
console.log(response);

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

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

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-update-settings.html