A watch can be either active or inactive. This API enables you to deactivate a currently active watch.
The status of an active watch is returned with the watch definition when you call the Get Watch API:
GET _xpack/watcher/watch/my_watch
{
"found": true,
"_id": "my_watch",
"_status": {
"state" : {
"active" : true,
"timestamp" : "2015-08-20T12:21:32.734Z"
},
"version": 1,
"actions": ...
},
"watch": ...
}You can deactivate the watch by executing the following API call:
PUT _xpack/watcher/watch/my_watch/_deactivate
The new state of the watch is returned as part of its overall status:
{
"_status": {
"state" : {
"active" : false,
"timestamp" : "2015-09-04T08:39:46.816Z"
},
"actions": ...
}
}