stop.asciidoc 1.4 KB

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