2017-06-27 20:16:51 -04:00
|
|
|
[role="xpack"]
|
2017-03-29 12:07:55 -04:00
|
|
|
[[watcher-api-stop]]
|
2019-09-04 20:03:05 -04:00
|
|
|
=== Stop watch service API
|
2018-12-20 13:23:28 -05:00
|
|
|
++++
|
2019-09-04 20:03:05 -04:00
|
|
|
<titleabbrev>Stop watch service</titleabbrev>
|
2018-12-20 13:23:28 -05:00
|
|
|
++++
|
2017-03-29 12:07:55 -04:00
|
|
|
|
2019-09-04 20:03:05 -04:00
|
|
|
Stops the {watcher} service if it is running.
|
2017-09-14 16:01:47 -04:00
|
|
|
|
2019-09-05 14:19:35 -04:00
|
|
|
[[watcher-api-stop-request]]
|
|
|
|
|
==== {api-request-title}
|
2017-09-14 16:01:47 -04:00
|
|
|
|
2018-12-08 13:57:16 -05:00
|
|
|
`POST _watcher/_stop`
|
2017-09-14 16:01:47 -04:00
|
|
|
|
2019-09-05 14:19:35 -04:00
|
|
|
[[watcher-api-stop-prereqs]]
|
|
|
|
|
==== {api-prereq-title}
|
2017-09-14 16:01:47 -04:00
|
|
|
|
2019-09-05 14:19:35 -04:00
|
|
|
* You must have `manage_watcher` cluster privileges to use this API. For more
|
|
|
|
|
information, see {stack-ov}/security-privileges.html[Security privileges].
|
2017-09-14 16:01:47 -04:00
|
|
|
|
2019-09-05 14:19:35 -04:00
|
|
|
//[[watcher-api-stop-desc]]
|
|
|
|
|
//==== {api-description-title}
|
|
|
|
|
|
|
|
|
|
//[[watcher-api-stop-path-params]]
|
|
|
|
|
//==== {api-path-parms-title}
|
|
|
|
|
|
|
|
|
|
//[[watcher-api-stop-query-params]]
|
|
|
|
|
//==== {api-query-parms-title}
|
|
|
|
|
|
|
|
|
|
//[[watcher-api-stop-request-body]]
|
|
|
|
|
//==== {api-request-body-title}
|
|
|
|
|
|
|
|
|
|
//[[watcher-api-stop-response-body]]
|
|
|
|
|
//==== {api-response-body-title}
|
|
|
|
|
|
|
|
|
|
//[[watcher-api-stop-response-codes]]
|
|
|
|
|
//==== {api-response-codes-title}
|
|
|
|
|
|
|
|
|
|
[[watcher-api-stop-example]]
|
|
|
|
|
==== {api-examples-title}
|
2017-03-29 12:07:55 -04:00
|
|
|
|
|
|
|
|
[source,js]
|
|
|
|
|
--------------------------------------------------
|
2018-12-08 13:57:16 -05:00
|
|
|
POST _watcher/_stop
|
2017-03-29 12:07:55 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
|
// CONSOLE
|
|
|
|
|
|
|
|
|
|
{watcher} returns the following response if the request is successful:
|
|
|
|
|
|
2019-09-06 09:22:08 -04:00
|
|
|
[source,console-result]
|
2017-03-29 12:07:55 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
|
{
|
|
|
|
|
"acknowledged": true
|
|
|
|
|
}
|
|
|
|
|
--------------------------------------------------
|
