delete-datafeed.asciidoc 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. [role="xpack"]
  2. [[ml-delete-datafeed]]
  3. = Delete {dfeeds} API
  4. [subs="attributes"]
  5. ++++
  6. <titleabbrev>Delete {dfeeds}</titleabbrev>
  7. ++++
  8. Deletes an existing {dfeed}.
  9. [[ml-delete-datafeed-request]]
  10. == {api-request-title}
  11. `DELETE _ml/datafeeds/<feed_id>`
  12. [[ml-delete-datafeed-prereqs]]
  13. == {api-prereq-title}
  14. * Requires the `manage_ml` cluster privilege. This privilege is included in the
  15. `machine_learning_admin` built-in role.
  16. * Unless you use the `force` parameter, you must stop the {dfeed} before you
  17. can delete it.
  18. [[ml-delete-datafeed-path-parms]]
  19. == {api-path-parms-title}
  20. `<feed_id>`::
  21. (Required, string)
  22. include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
  23. [[ml-delete-datafeed-query-parms]]
  24. == {api-query-parms-title}
  25. `force`::
  26. (Optional, Boolean) Use to forcefully delete a started {dfeed}; this method is
  27. quicker than stopping and deleting the {dfeed}.
  28. [[ml-delete-datafeed-example]]
  29. == {api-examples-title}
  30. [source,console]
  31. --------------------------------------------------
  32. DELETE _ml/datafeeds/datafeed-total-requests
  33. --------------------------------------------------
  34. // TEST[skip:setup:server_metrics_datafeed]
  35. When the {dfeed} is deleted, you receive the following results:
  36. [source,console-result]
  37. ----
  38. {
  39. "acknowledged": true
  40. }
  41. ----