delete-dfanalytics.asciidoc 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  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) Identifier for the {dfanalytics-job} you want to delete.
  22. [[ml-delete-dfanalytics-example]]
  23. ==== {api-examples-title}
  24. The following example deletes the `loganalytics` {dfanalytics-job}:
  25. [source,console]
  26. --------------------------------------------------
  27. DELETE _ml/data_frame/analytics/loganalytics
  28. --------------------------------------------------
  29. // TEST[skip:TBD]
  30. The API returns the following result:
  31. [source,console-result]
  32. ----
  33. {
  34. "acknowledged" : true
  35. }
  36. ----