OpenSearch/docs/en/rest-api/ml/delete-datafeed.asciidoc

60 lines
1.2 KiB
Plaintext
Raw Normal View History

[role="xpack"]
[[ml-delete-datafeed]]
=== Delete {dfeeds-cap} API
++++
<titleabbrev>Delete {dfeeds-cap}</titleabbrev>
++++
This API enables you to delete an existing {dfeed}.
==== Request
`DELETE _xpack/ml/datafeeds/<feed_id>`
==== Description
NOTE: Unless the `force` parameter is used, the {dfeed} must be stopped before it can be deleted.
==== Path Parameters
`feed_id` (required)::
(string) Identifier for the {dfeed}
===== Query Parameters
`force`::
(boolean) Use to forcefully delete a started {dfeed}; this method is quicker than
stopping and deleting the {dfeed}.
===== Authorization
You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see {xpack-ref}/security-privileges.html[Security Privileges].
//<<privileges-list-cluster>>.
==== Examples
The following example deletes the `datafeed-total-requests` {dfeed}:
[source,js]
--------------------------------------------------
DELETE _xpack/ml/datafeeds/datafeed-total-requests
--------------------------------------------------
// CONSOLE
// TEST[setup:server_metrics_datafeed]
When the {dfeed} is deleted, you receive the following results:
[source,js]
----
{
"acknowledged": true
}
----
// TESTRESPONSE