delete-dfanalytics.asciidoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[delete-dfanalytics]]
  4. === Delete {dfanalytics-jobs} API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Delete {dfanalytics-jobs}</titleabbrev>
  8. ++++
  9. Deletes an existing {dfanalytics-job}.
  10. experimental[]
  11. [[ml-delete-dfanalytics-request]]
  12. ==== {api-request-title}
  13. `DELETE _ml/data_frame/analytics/<data_frame_analytics_id>`
  14. [[ml-delete-dfanalytics-prereq]]
  15. ==== {api-prereq-title}
  16. If the {es} {security-features} are enabled, you must have the following
  17. built-in roles or equivalent privileges:
  18. * `machine_learning_admin`
  19. * `kibana_admin` (UI only)
  20. For more information, see <<security-privileges>> and <<built-in-roles>>.
  21. [[ml-delete-dfanalytics-path-params]]
  22. ==== {api-path-parms-title}
  23. `<data_frame_analytics_id>`::
  24. (Required, string)
  25. include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
  26. [[ml-delete-dfanalytics-query-params]]
  27. ==== {api-query-parms-title}
  28. `force`::
  29. (Optional, boolean) If `true`, it deletes a job that is not stopped; this method is
  30. quicker than stopping and deleting the job.
  31. [[ml-delete-dfanalytics-example]]
  32. ==== {api-examples-title}
  33. The following example deletes the `loganalytics` {dfanalytics-job}:
  34. [source,console]
  35. --------------------------------------------------
  36. DELETE _ml/data_frame/analytics/loganalytics
  37. --------------------------------------------------
  38. // TEST[skip:TBD]
  39. The API returns the following result:
  40. [source,console-result]
  41. ----
  42. {
  43. "acknowledged" : true
  44. }
  45. ----