delete-dfanalytics.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  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. * You must have `machine_learning_admin` built-in role to use this API. For more
  17. information, see <<security-privileges>> and <<built-in-roles>>.
  18. [[ml-delete-dfanalytics-path-params]]
  19. ==== {api-path-parms-title}
  20. `<data_frame_analytics_id>`::
  21. (Required, string)
  22. include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
  23. [[ml-delete-dfanalytics-example]]
  24. ==== {api-examples-title}
  25. The following example deletes the `loganalytics` {dfanalytics-job}:
  26. [source,console]
  27. --------------------------------------------------
  28. DELETE _ml/data_frame/analytics/loganalytics
  29. --------------------------------------------------
  30. // TEST[skip:TBD]
  31. The API returns the following result:
  32. [source,console-result]
  33. ----
  34. {
  35. "acknowledged" : true
  36. }
  37. ----