delete-datafeed.asciidoc 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  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-desc]]
  14. ==== {api-description-title}
  15. NOTE: Unless the `force` parameter is used, the {dfeed} must be stopped before it can be deleted.
  16. [[ml-delete-datafeed-path-parms]]
  17. ==== {api-path-parms-title}
  18. `feed_id` (required)::
  19. (string) Identifier for the {dfeed}
  20. [[ml-delete-datafeed-query-parms]]
  21. ==== {api-query-parms-title}
  22. `force`::
  23. (boolean) Use to forcefully delete a started {dfeed}; this method is quicker than
  24. stopping and deleting the {dfeed}.
  25. [[ml-delete-datafeed-prereqs]]
  26. ==== {api-prereq-title}
  27. You must have `manage_ml`, or `manage` cluster privileges to use this API.
  28. For more information, see {stack-ov}/security-privileges.html[Security privileges].
  29. [[ml-delete-datafeed-example]]
  30. ==== {api-examples-title}
  31. The following example deletes the `datafeed-total-requests` {dfeed}:
  32. [source,js]
  33. --------------------------------------------------
  34. DELETE _ml/datafeeds/datafeed-total-requests
  35. --------------------------------------------------
  36. // CONSOLE
  37. // TEST[skip:setup:server_metrics_datafeed]
  38. When the {dfeed} is deleted, you receive the following results:
  39. [source,js]
  40. ----
  41. {
  42. "acknowledged": true
  43. }
  44. ----
  45. // TESTRESPONSE