Michael Basnight b5b6e37a60
Deprecate X-Pack centric watcher endpoints (#36218)
This commit is part of our plan to deprecate and ultimately remove the use of
_xpack in the REST APIs.

Relates #35958
2018-12-08 12:57:16 -06:00

36 lines
756 B
Plaintext

[role="xpack"]
[[watcher-api-start]]
=== Start API
The `start` API starts the {watcher} service if the service 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