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.

› › ›

Deactivate watch API

edit

Deactivate watch API

edit

A watch can be either active or inactive. This API enables you to deactivate a currently active watch.

Request

edit

PUT _watcher/watch/<watch_id>/_deactivate

Prerequisites

edit

You must have manage_watcher cluster privileges to use this API. For more information, see Security privileges.

Path parameters

edit

<watch_id>: (Required, string) Identifier for the watch.

Examples

edit

The status of an active watch is returned with the watch definition when you call the get watch API:

resp = client.watcher.get_watch(
    id="my_watch",
)
print(resp)

const response = await client.watcher.getWatch({
  id: "my_watch",
});
console.log(response);

GET _watcher/watch/my_watch

{
  "found": true,
  "_id": "my_watch",
  "_version": 1,
  "_seq_no": 0,
  "_primary_term": 1,
  "status": {
    "state" : {
      "active" : true,
      "timestamp" : "2015-08-20T12:21:32.734Z"
    },
    "actions": ...,
    "version": 1
  },
  "watch": ...
}

You can deactivate the watch by executing the following API call:

resp = client.watcher.deactivate_watch(
    watch_id="my_watch",
)
print(resp)

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

PUT _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": ...,
    "version": 1
  }
}

« Activate watch API Delete watch API »