Acknowledge a watch
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).
Path parameters
-
The watch identifier.
-
A comma-separated list of the action identifiers to acknowledge. If you omit this parameter, all of the actions of the watch are acknowledged.
curl \
-X PUT http://api.example.com/_watcher/watch/{watch_id}/_ack/{action_id}
{
"status": {
"actions": {
"additionalProperty1": {
"ack": {
"state": "awaits_successful_execution",
"": "string"
},
"last_execution": {
"successful": true,
"": "string",
"reason": "string"
},
"last_successful_execution": {
"successful": true,
"": "string",
"reason": "string"
},
"last_throttle": {
"reason": "string",
"": "string"
}
},
"additionalProperty2": {
"ack": {
"state": "awaits_successful_execution",
"": "string"
},
"last_execution": {
"successful": true,
"": "string",
"reason": "string"
},
"last_successful_execution": {
"successful": true,
"": "string",
"reason": "string"
},
"last_throttle": {
"reason": "string",
"": "string"
}
}
},
"": "string",
"state": {
"active": true,
"": "string"
},
"version": 42.0,
"execution_state": "string"
}
}