delete-datafeed.asciidoc 1.3 KB

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