Acknowledge a watch

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

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.

Path parameters

  • watch_id string Required

    Watch ID

  • action_id string | array[string] Required

    A comma-separated list of the action ids to be acked

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • status object Required

      Additional properties are allowed.

      Hide status attributes Show status attributes object
POST /_watcher/watch/{watch_id}/_ack/{action_id} 
curl \
 -X POST http://api.example.com/_watcher/watch/{watch_id}/_ack/{action_id}
Response examples (200) 
{
  "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"
  }
}