Acknowledge a watch

POST also PUT /_watcher/watch/{watch_id}/_ack/{action_id}
POST also PUT /_watcher/watch/{watch_id}/_ack

Auth

Acknowledging a watch enables you to manually throttle the execution of the watch's actions.

The acknowledgement state of an action is stored in the status.actions.<id>.ack.state structure.

Important

If the specified watch is currently being executed, this API will return an error The reason for this behavior is to prevent overwriting the watch status from a watch execution.

Acknowledging an action throttles further executions of that action until its ack.state is reset to awaits_successful_execution. This happens when the condition of the watch is not met (the condition evaluates to false). To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.

Learn more about actions

Required authorization

Cluster privileges manage_watcher

Path parameters

watch_id string required

The watch identifier.

action_id union string | string[] optional

A comma-separated list of the action identifiers to acknowledge. If you omit this parameter, all of the actions of the watch are acknowledged.

Leave it out to use /_watcher/watch/{watch_id}/_ack.

Response

application/json

status object required