delete-datafeed.asciidoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[ml-delete-datafeed]]
  4. === Delete {dfeeds} API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Delete {dfeeds}</titleabbrev>
  8. ++++
  9. Deletes an existing {dfeed}.
  10. [[ml-delete-datafeed-request]]
  11. ==== {api-request-title}
  12. `DELETE _ml/datafeeds/<feed_id>`
  13. [[ml-delete-datafeed-prereqs]]
  14. ==== {api-prereq-title}
  15. * If the {es} {security-features} are enabled, you must have `manage_ml` or
  16. `manage` cluster privileges to use this API. See
  17. {stack-ov}/security-privileges.html[Security privileges].
  18. [[ml-delete-datafeed-desc]]
  19. ==== {api-description-title}
  20. NOTE: Unless you use the `force` parameter, you must stop the {dfeed} before you
  21. can delete it.
  22. [[ml-delete-datafeed-path-parms]]
  23. ==== {api-path-parms-title}
  24. `<feed_id>` (Required)::
  25. (string) Identifier for the {dfeed}.
  26. [[ml-delete-datafeed-query-parms]]
  27. ==== {api-query-parms-title}
  28. `force` (Optional)::
  29. (boolean) Use to forcefully delete a started {dfeed}; this method is quicker
  30. than stopping and deleting the {dfeed}.
  31. [[ml-delete-datafeed-example]]
  32. ==== {api-examples-title}
  33. The following example deletes the `datafeed-total-requests` {dfeed}:
  34. [source,js]
  35. --------------------------------------------------
  36. DELETE _ml/datafeeds/datafeed-total-requests
  37. --------------------------------------------------
  38. // CONSOLE
  39. // TEST[skip:setup:server_metrics_datafeed]
  40. When the {dfeed} is deleted, you receive the following results:
  41. [source,js]
  42. ----
  43. {
  44. "acknowledged": true
  45. }
  46. ----
  47. // TESTRESPONSE