start.asciidoc 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. [role="xpack"]
  2. [[watcher-api-start]]
  3. === Start watch service API
  4. ++++
  5. <titleabbrev>Start watch service</titleabbrev>
  6. ++++
  7. Starts the {watcher} service if it is not already running.
  8. [[watcher-api-start-request]]
  9. ==== {api-request-title}
  10. `POST _watcher/_start`
  11. [[watcher-api-start-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-start-desc]]
  16. //==== {api-description-title}
  17. //[[watcher-api-start-path-params]]
  18. //==== {api-path-parms-title}
  19. //[[watcher-api-start-query-params]]
  20. //==== {api-query-parms-title}
  21. //[[watcher-api-start-request-body]]
  22. //==== {api-request-body-title}
  23. //[[watcher-api-start-response-body]]
  24. //==== {api-response-body-title}
  25. //[[watcher-api-start-response-codes]]
  26. //==== {api-response-codes-title}
  27. [[watcher-api-start-example]]
  28. ==== {api-examples-title}
  29. [source,console]
  30. --------------------------------------------------
  31. POST _watcher/_start
  32. --------------------------------------------------
  33. {watcher} returns the following response if the request is successful:
  34. [source,console-result]
  35. --------------------------------------------------
  36. {
  37. "acknowledged": true
  38. }
  39. --------------------------------------------------