stop.asciidoc 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. [role="xpack"]
  2. [[watcher-api-stop]]
  3. === Stop watch service API
  4. ++++
  5. <titleabbrev>Stop watch service</titleabbrev>
  6. ++++
  7. Stops the {watcher} service if it is running.
  8. [[watcher-api-stop-request]]
  9. ==== {api-request-title}
  10. `POST _watcher/_stop`
  11. [[watcher-api-stop-prereqs]]
  12. ==== {api-prereq-title}
  13. * You must have `manage_watcher` cluster privileges to use this API. For more
  14. information, see <<security-privileges>>.
  15. //[[watcher-api-stop-desc]]
  16. //==== {api-description-title}
  17. //[[watcher-api-stop-path-params]]
  18. //==== {api-path-parms-title}
  19. [[watcher-api-stop-query-params]]
  20. ==== {api-query-parms-title}
  21. include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
  22. //[[watcher-api-stop-request-body]]
  23. //==== {api-request-body-title}
  24. //[[watcher-api-stop-response-body]]
  25. //==== {api-response-body-title}
  26. //[[watcher-api-stop-response-codes]]
  27. //==== {api-response-codes-title}
  28. [[watcher-api-stop-example]]
  29. ==== {api-examples-title}
  30. [source,console]
  31. --------------------------------------------------
  32. POST _watcher/_stop
  33. --------------------------------------------------
  34. {watcher} returns the following response if the request is successful:
  35. [source,console-result]
  36. --------------------------------------------------
  37. {
  38. "acknowledged": true
  39. }
  40. --------------------------------------------------