elasticsearch/docs/reference/rest-api/watcher/start.asciidoc
David Turner ccbb5badce
Fix support for infinite ?master_timeout (#107050)
Specifying `?master_timeout=-1` on an API which performs a cluster state
update means that the cluster state update task will never time out
while waiting in the pending tasks queue. However this parameter is also
re-used in a few places where a timeout of `-1` means something else,
typically to timeout immediately. This commit fixes those places so that
`?master_timeout=-1` consistently means to wait forever.
2024-04-10 18:32:38 +01:00

56 lines
1.3 KiB
Text

[role="xpack"]
[[watcher-api-start]]
=== Start watch service API
++++
<titleabbrev>Start watch service</titleabbrev>
++++
Starts the {watcher} service if it is not already running.
[[watcher-api-start-request]]
==== {api-request-title}
`POST _watcher/_start`
[[watcher-api-start-prereqs]]
==== {api-prereq-title}
* You must have `manage_watcher` cluster privileges to use this API. For more
information, see <<security-privileges>>.
//[[watcher-api-start-desc]]
//==== {api-description-title}
//[[watcher-api-start-path-params]]
//==== {api-path-parms-title}
[[watcher-api-start-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
//[[watcher-api-start-request-body]]
//==== {api-request-body-title}
//[[watcher-api-start-response-body]]
//==== {api-response-body-title}
//[[watcher-api-start-response-codes]]
//==== {api-response-codes-title}
[[watcher-api-start-example]]
==== {api-examples-title}
[source,console]
--------------------------------------------------
POST _watcher/_start
--------------------------------------------------
{watcher} returns the following response if the request is successful:
[source,console-result]
--------------------------------------------------
{
"acknowledged": true
}
--------------------------------------------------