start-job.asciidoc 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. [role="xpack"]
  2. [[rollup-start-job]]
  3. === Start {rollup-jobs} API
  4. [subs="attributes"]
  5. ++++
  6. <titleabbrev>Start {rollup-jobs}</titleabbrev>
  7. ++++
  8. Starts an existing, stopped {rollup-job}.
  9. experimental[]
  10. [[rollup-start-job-request]]
  11. ==== {api-request-title}
  12. `POST _rollup/job/<job_id>/_start`
  13. [[rollup-start-job-prereqs]]
  14. ==== {api-prereq-title}
  15. * If the {es} {security-features} are enabled, you must have `manage` or
  16. `manage_rollup` cluster privileges to use this API. For more information, see
  17. <<security-privileges>>.
  18. [[rollup-start-job-desc]]
  19. ==== {api-description-title}
  20. If you try to start a job that does not exist, an exception occurs. If you try
  21. to start a job that is already started, nothing happens.
  22. [[rollup-start-job-path-params]]
  23. ==== {api-path-parms-title}
  24. `<job_id>`::
  25. (Required, string) Identifier for the {rollup-job}.
  26. [[rollup-start-job-response-codes]]
  27. ==== {api-response-codes-title}
  28. `404` (Missing resources)::
  29. This code indicates that there are no resources that match the request. It
  30. occurs if you try to start a job that doesn't exist.
  31. [[rollup-start-job-examples]]
  32. ==== {api-examples-title}
  33. If we have already created a {rollup-job} named `sensor`, it can be started with:
  34. [source,console]
  35. --------------------------------------------------
  36. POST _rollup/job/sensor/_start
  37. --------------------------------------------------
  38. // TEST[setup:sensor_rollup_job]
  39. Which will return the response:
  40. [source,console-result]
  41. ----
  42. {
  43. "started": true
  44. }
  45. ----