delete-datafeed.asciidoc 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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. ==== Request
  11. `DELETE _ml/datafeeds/<feed_id>`
  12. ==== Description
  13. NOTE: Unless the `force` parameter is used, the {dfeed} must be stopped before it can be deleted.
  14. ==== Path Parameters
  15. `feed_id` (required)::
  16. (string) Identifier for the {dfeed}
  17. ===== Query Parameters
  18. `force`::
  19. (boolean) Use to forcefully delete a started {dfeed}; this method is quicker than
  20. stopping and deleting the {dfeed}.
  21. ===== Authorization
  22. You must have `manage_ml`, or `manage` cluster privileges to use this API.
  23. For more information, see {xpack-ref}/security-privileges.html[Security Privileges].
  24. //<<privileges-list-cluster>>.
  25. ==== Examples
  26. The following example deletes the `datafeed-total-requests` {dfeed}:
  27. [source,js]
  28. --------------------------------------------------
  29. DELETE _ml/datafeeds/datafeed-total-requests
  30. --------------------------------------------------
  31. // CONSOLE
  32. // TEST[skip:setup:server_metrics_datafeed]
  33. When the {dfeed} is deleted, you receive the following results:
  34. [source,js]
  35. ----
  36. {
  37. "acknowledged": true
  38. }
  39. ----
  40. // TESTRESPONSE