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

48 lines
915 B
Plaintext
Raw Normal View History

//lcawley Verified example output 2017-04-11
[[ml-delete-datafeed]]
==== Delete {dfeeds-cap}
The delete {dfeed} API enables you to delete an existing {dfeed}.
===== Request
`DELETE _xpack/ml/datafeeds/<feed_id>`
===== Description
NOTE: You must stop the {dfeed} before you can delete it.
===== Path Parameters
`feed_id` (required)::
(string) Identifier for the {dfeed}
===== Authorization
You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see <<privileges-list-cluster>>.
===== Examples
The following example deletes the `datafeed-it-ops` {dfeed}:
[source,js]
--------------------------------------------------
DELETE _xpack/ml/datafeeds/datafeed-it-ops
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]
When the {dfeed} is deleted, you receive the following results:
[source,js]
----
{
"acknowledged": true
}
----