start.asciidoc 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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. `master_timeout`::
  22. (Optional, <<time-units, time units>>) Specifies the period of time to wait for
  23. a connection to the master node. If no response is received before the timeout
  24. expires, the request fails and returns an error. Defaults to `30s`.
  25. //[[watcher-api-start-request-body]]
  26. //==== {api-request-body-title}
  27. //[[watcher-api-start-response-body]]
  28. //==== {api-response-body-title}
  29. //[[watcher-api-start-response-codes]]
  30. //==== {api-response-codes-title}
  31. [[watcher-api-start-example]]
  32. ==== {api-examples-title}
  33. [source,console]
  34. --------------------------------------------------
  35. POST _watcher/_start
  36. --------------------------------------------------
  37. {watcher} returns the following response if the request is successful:
  38. [source,console-result]
  39. --------------------------------------------------
  40. {
  41. "acknowledged": true
  42. }
  43. --------------------------------------------------