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.
« Start watch service API Definitions »
Elastic Docs ›Elasticsearch Guide [master] ›REST APIs ›Watcher APIs

Stop watch service API

edit

Stop watch service API

edit

Stops the Watcher service if it is running.

Request

edit

POST _watcher/_stop

Prerequisites

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

Query parameters

edit
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

edit
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
}
« Start watch service API Definitions »