This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Activate watch API
editActivate watch APIedit
A watch can be either active or inactive. This API enables you to activate a currently inactive watch.
Requestedit
PUT _watcher/watch/<watch_id>/_activate
Prerequisitesedit
-
You must have
manage_watcher
cluster privileges to use this API. For more information, see Security privileges.
Path parametersedit
-
<watch_id>
- (Required, string) Identifier for the watch.
Examplesedit
The status of an inactive watch is returned with the watch definition when you call the get watch API:
GET _watcher/watch/my_watch
{ "found": true, "_id": "my_watch", "_seq_no": 0, "_primary_term": 1, "_version": 1, "status": { "state" : { "active" : false, "timestamp" : "2015-08-20T12:21:32.734Z" }, "actions": ..., "version": 1 }, "watch": ... }
You can activate the watch by executing the following API call:
PUT _watcher/watch/my_watch/_activate
The new state of the watch is returned as part of its overall status:
{ "status": { "state" : { "active" : true, "timestamp" : "2015-09-04T08:39:46.816Z" }, "actions": ..., "version": 1 } }