34 lines
1.0 KiB
Plaintext
34 lines
1.0 KiB
Plaintext
|
--
|
||
|
|
:api: stop-watch-service
|
||
|
|
:request: StopWatchServiceRequest
|
||
|
|
:response: StopWatchServiceResponse
|
||
|
|
--
|
||
|
|
[id="{upid}-{api}"]
|
||
|
|
=== Stop Watch Service API
|
||
|
|
|
||
|
|
[[java-rest-high-watcher-stop-watch-service-execution]]
|
||
|
|
==== Execution
|
||
|
|
|
||
|
|
{xpack-ref}/watcher-api-stop.html[Stop watcher] enables you
|
||
|
|
to manually stop the watch service. Submit the following request
|
||
|
|
to stop the watch service:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
||
|
|
--------------------------------------------------
|
||
|
|
|
||
|
|
[[java-rest-high-watcher-stop-watch-service-response]]
|
||
|
|
==== Response
|
||
|
|
|
||
|
|
The returned `AcknowledgeResponse` contains a value on whether or not the request
|
||
|
|
was received:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> A boolean value of `true` if successfully received, `false` otherwise.
|
||
|
|
|
||
|
|
include::../execution.asciidoc[]
|