stop-watch-service.asciidoc 1.0 KB

12345678910111213141516171819202122232425262728293031323334
  1. --
  2. :api: stop-watch-service
  3. :request: StopWatchServiceRequest
  4. :response: StopWatchServiceResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Stop watch service API
  9. [[java-rest-high-watcher-stop-watch-service-execution]]
  10. ==== Execution
  11. {ref}/watcher-api-stop.html[Stop watcher] enables you
  12. to manually stop the watch service. Submit the following request
  13. to stop the watch service:
  14. ["source","java",subs="attributes,callouts,macros"]
  15. --------------------------------------------------
  16. include-tagged::{doc-tests-file}[{api}-request]
  17. --------------------------------------------------
  18. [[java-rest-high-watcher-stop-watch-service-response]]
  19. ==== Response
  20. The returned `AcknowledgeResponse` contains a value on whether or not the request
  21. was received:
  22. ["source","java",subs="attributes,callouts,macros"]
  23. --------------------------------------------------
  24. include-tagged::{doc-tests-file}[{api}-response]
  25. --------------------------------------------------
  26. <1> A boolean value of `true` if successfully received, `false` otherwise.
  27. include::../execution.asciidoc[]