mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
255c9a7f95
**Problem:** For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. **Solution:** - Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory - Update doc snippet tests to use security Rel: https://github.com/elastic/platform-docs-team/issues/208
59 lines
1.5 KiB
Text
59 lines
1.5 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}
|
|
|
|
`master_timeout`::
|
|
(Optional, <<time-units, 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`.
|
|
|
|
//[[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
|
|
}
|
|
--------------------------------------------------
|