delete-dfanalytics.asciidoc 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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 {stack-ov}/security-privileges.html[Security privileges] and
  18. {stack-ov}/built-in-roles.html[Built-in roles].
  19. [[ml-delete-dfanalytics-path-params]]
  20. ==== {api-path-parms-title}
  21. `<data_frame_analytics_id>`::
  22. (Required, string) Identifier for the {dfanalytics-job} you want to delete.
  23. [[ml-delete-dfanalytics-example]]
  24. ==== {api-examples-title}
  25. The following example deletes the `loganalytics` {dfanalytics-job}:
  26. [source,js]
  27. --------------------------------------------------
  28. DELETE _ml/data_frame/analytics/loganalytics
  29. --------------------------------------------------
  30. // CONSOLE
  31. // TEST[skip:TBD]
  32. The API returns the following result:
  33. [source,js]
  34. ----
  35. {
  36. "acknowledged" : true
  37. }
  38. ----
  39. // TESTRESPONSE