elasticsearch/docs/reference/rest-api/watcher/update-settings.asciidoc
2024-12-31 12:02:59 -08:00

54 lines
1.3 KiB
Text

[role="xpack"]
[[watcher-api-update-settings]]
=== Update Watcher index settings
++++
<titleabbrev>Update Watcher settings</titleabbrev>
++++
.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
--
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:
[source,console]
----------------------------------------------------------------
PUT /_watcher/watch/test_watch
{
"trigger": {
"schedule": {
"hourly": {
"minute": [ 0, 5 ]
}
}
},
"input": {
"simple": {
"payload": {
"send": "yes"
}
}
},
"condition": {
"always": {}
}
}
----------------------------------------------------------------
// TESTSETUP
[source,console]
-----------------------------------------------------------
PUT /_watcher/settings
{
"index.auto_expand_replicas": "0-4"
}
-----------------------------------------------------------
The configurable settings can be retrieved using the <<watcher-api-get-settings,Get Watcher index settings>> API.