Delete watch API
editDelete watch API
editThe DELETE watch API removes a watch from Watcher.
Request
editDELETE _xpack/watcher/watch/<watch_id>
Description
editWhen the watch is removed, the document representing the watch in the .watches
index is gone and it will never be run again.
Please note that deleting a watch does not delete any watch execution records related to this watch from the watch history.
Deleting a watch must be done via this API only. Do not delete the
watch directly from the .watches
index using the Elasticsearch
DELETE Document API. When X-Pack security is enabled, make sure no write
privileges are granted to anyone over the .watches
index.
Path Parameters
edit-
watch_id
(required) - (string) Identifier for the watch.
Authorization
editYou must have manage_watcher
cluster privileges to use this API. For more
information, see Security privileges.
Examples
editThe following example deletes a watch with the my-watch
id:
DELETE _xpack/watcher/watch/my_watch
Response:
{ "found": true, "_id": "my_watch", "_version": 2 }