stop.asciidoc 758 B

1234567891011121314151617181920212223242526272829303132333435
  1. [role="xpack"]
  2. [[watcher-api-stop]]
  3. === Stop API
  4. The `stop` API stops the {watcher} service if the service is running.
  5. [float]
  6. ==== Request
  7. `POST _xpack/watcher/_stop`
  8. [float]
  9. ==== Authorization
  10. You must have `manage_watcher` cluster privileges to use this API. For more
  11. information, see {xpack-ref}/security-privileges.html[Security Privileges].
  12. [float]
  13. ==== Examples
  14. [source,js]
  15. --------------------------------------------------
  16. POST _xpack/watcher/_stop
  17. --------------------------------------------------
  18. // CONSOLE
  19. {watcher} returns the following response if the request is successful:
  20. [source,js]
  21. --------------------------------------------------
  22. {
  23. "acknowledged": true
  24. }
  25. --------------------------------------------------
  26. // TESTRESPONSE