› › ›

Stop watch service API

Stops the Watcher service if it is running.

Request

POST _watcher/_stop

Prerequisites

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

Query parameters

master_timeout: (Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

Examples

resp = client.watcher.stop()
print(resp)

response = client.watcher.stop
puts response

const response = await client.watcher.stop();
console.log(response);

POST _watcher/_stop

Watcher returns the following response if the request is successful:

{
   "acknowledged": true
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stop.html