1
0

start.asciidoc 1.4 KB

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