Stop watch service API

Stop watch service API

New API reference

For the most up-to-date API details, refer to Watcher APIs.

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

  1. resp = client.watcher.stop()
  2. print(resp)
  1. response = client.watcher.stop
  2. puts response
  1. const response = await client.watcher.stop();
  2. console.log(response);
  1. POST _watcher/_stop

Watcher returns the following response if the request is successful:

  1. {
  2.    "acknowledged": true
  3. }