OpenSearch/x-pack/docs/en/rest-api/watcher/start.asciidoc

38 lines
802 B
Plaintext

[role="xpack"]
[[watcher-api-start]]
=== Start watch service API
++++
<titleabbrev>Start watch service</titleabbrev>
++++
Starts the {watcher} service if it is not already running.
[float]
==== Request
`POST _watcher/_start`
==== Authorization
You must have `manage_watcher` cluster privileges to use this API. For more
information, see {xpack-ref}/security-privileges.html[Security Privileges].
[float]
==== Examples
[source,js]
--------------------------------------------------
POST _watcher/_start
--------------------------------------------------
// CONSOLE
{watcher} returns the following response if the request is successful:
[source,js]
--------------------------------------------------
{
"acknowledged": true
}
--------------------------------------------------
// TESTRESPONSE