delete-datafeed.asciidoc 1.2 KB

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