mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-04-12 10:20:52 +00:00
268f5a95af
* [DOCS] Edits for description of ML results resource * [DOCS] Adds Authorization section to ML API pages Original commit: elastic/x-pack-elasticsearch@797761e7ae
58 lines
1.2 KiB
Plaintext
58 lines
1.2 KiB
Plaintext
//lcawley Verified example output 2017-04-11
|
|
[[ml-delete-datafeed]]
|
|
==== Delete Data Feeds
|
|
|
|
The delete data feed API allows you to delete an existing data feed.
|
|
|
|
|
|
===== Request
|
|
|
|
`DELETE _xpack/ml/datafeeds/<feed_id>`
|
|
|
|
|
|
===== Description
|
|
|
|
NOTE: You must stop the data feed before you can delete it.
|
|
|
|
|
|
===== Path Parameters
|
|
|
|
`feed_id` (required)::
|
|
(string) Identifier for the data feed
|
|
////
|
|
===== Responses
|
|
|
|
200
|
|
(EmptyResponse) The cluster has been successfully deleted
|
|
404
|
|
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: clusters.cluster_not_found)
|
|
412
|
|
(BasicFailedReply) The Elasticsearch cluster has not been shutdown yet (code: clusters.cluster_plan_state_error)
|
|
////
|
|
|
|
|
|
===== 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` data feed:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
DELETE _xpack/ml/datafeeds/datafeed-it-ops
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:todo]
|
|
|
|
When the data feed is deleted, you receive the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
----
|