mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 04:58:50 +00:00
b41ff62bcc
* [DOCS] Update ML APIs for Elasticsearch Reference * [DOCS] Add X-Pack icon for ML APIs * [DOCS] Add role attribute to ML APIs Original commit: elastic/x-pack-elasticsearch@997ea39759
56 lines
1.1 KiB
Plaintext
56 lines
1.1 KiB
Plaintext
[role="xpack"]
|
|
[[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: 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-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
|
|
}
|
|
----
|