Activate a watch

POST also PUT /_watcher/watch/{watch_id}/_activate

Auth

A watch can be either active or inactive.

Read the reference documentation

Required privileges

Cluster privileges manage_watcher

Path parameters

watch_id string required: The watch identifier.

Response

application/json

status object required

View as Markdown

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

POST _watcher/watch/my_watch/_activate

JavaScript Elasticsearch JavaScript Client

const response = await client.watcher.activateWatch({
  watch_id: "my_watch",
});

Python Elasticsearch Python Client

resp = client.watcher.activate_watch(
    watch_id="my_watch",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_watcher/watch/my_watch/_activate" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.watcher().activateWatch(a -> a
    .watchId("my_watch")
);

PHP Elasticsearch PHP Client

$resp = $client->watcher()->activateWatch([
    "watch_id" => "my_watch",
]);

Ruby Elasticsearch Ruby Client

response = client.watcher.activate_watch(
  watch_id: "my_watch"
)

Response

{
  "status": {
    "actions": {
      "key": {
        "ack": {
          "state": "awaits_successful_execution"
        },
        "last_execution": {
          "successful": false,
          "reason": "string"
        },
        "last_successful_execution": {
          "successful": false,
          "reason": "string"
        },
        "last_throttle": {
          "reason": "string"
        }
      }
    },
    "state": {
      "active": false,
      "timestamp": "string"
    },
    "version": 0
  }
}

Generated from the API spec