WARNING: Version 5.2 of the Elastic Stack has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Delete Watch API
editDelete Watch API
editThe DELETE watch API removes a watch (identified by its id) from Watcher.
Once removed, the document representing the watch in the .watches index is
gone and it will never be executed 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 Elasticsearch’s
DELETE Document API. When X-Pack security is enabled, make sure no write
privileges are granted to anyone over the .watches index.
The following example deletes a watch with the my-watch id:
DELETE _xpack/watcher/watch/my_watch
Response:
{
"found": true,
"_id": "my_watch",
"_version": 2
}
Timeouts
editWhen deleting a watch while it is executing, the delete action will block and
wait for the watch execution to finish. Depending on the nature of the watch, in
some situations this can take a while. For this reason, the delete watch action
is associated with a timeout that is set to 10 seconds by default. You can
control this timeout by passing in the master_timeout parameter.
The following snippet shows how to change the default timeout of the delete action to 30 seconds:
DELETE _xpack/watcher/watch/my_watch?master_timeout=30s