Skip to content

Commit c1178ee

Browse files
committed
[DOCS] Document throttle_period_in_millis for watcher actions (#45607)
1 parent f6a53ee commit c1178ee

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

x-pack/docs/en/rest-api/watcher/put-watch.asciidoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,18 @@ A watch has the following fields:
6868

6969
| `throttle_period` | The minimum time between actions being run, the default
7070
for this is 5 seconds. This default can be changed in the
71-
config file with the setting `xpack.watcher.throttle.period.default_period`.
71+
config file with the setting
72+
`xpack.watcher.throttle.period.default_period`. If both
73+
this value and the `throttle_period_in_millis` parameter
74+
are specified, {watcher} uses the last parameter
75+
included in the request.
76+
77+
| `throttle_period_in_millis` | Minimum time in milliseconds between actions
78+
being run. Defaults to `5000`. If both this
79+
value and the `throttle_period` parameter are
80+
specified, {watcher} uses the last parameter
81+
included in the request.
82+
7283
|======
7384

7485
[float]

0 commit comments

Comments
 (0)