delete-datafeed.asciidoc 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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. * Unless you use the `force` parameter, you must stop the {dfeed} before you
  16. can delete it.
  17. * If the {es} {security-features} are enabled, you must have `manage_ml` or
  18. `manage` cluster privileges to use this API. See
  19. <<security-privileges>> and {ml-docs-setup-privileges}.
  20. [[ml-delete-datafeed-path-parms]]
  21. == {api-path-parms-title}
  22. `<feed_id>`::
  23. (Required, string)
  24. include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
  25. [[ml-delete-datafeed-query-parms]]
  26. == {api-query-parms-title}
  27. `force`::
  28. (Optional, boolean) Use to forcefully delete a started {dfeed}; this method is
  29. quicker than stopping and deleting the {dfeed}.
  30. [[ml-delete-datafeed-example]]
  31. == {api-examples-title}
  32. [source,console]
  33. --------------------------------------------------
  34. DELETE _ml/datafeeds/datafeed-total-requests
  35. --------------------------------------------------
  36. // TEST[skip:setup:server_metrics_datafeed]
  37. When the {dfeed} is deleted, you receive the following results:
  38. [source,console-result]
  39. ----
  40. {
  41. "acknowledged": true
  42. }
  43. ----