› › ›

Start watch service API

Starts the Watcher service if it is not already running.

Request

POST _watcher/_start

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) Specifies the period of time to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Examples

POST _watcher/_start

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/7.17/watcher-api-start.html