2017-06-19 18:23:58 -07:00
|
|
|
[role="xpack"]
|
2017-04-04 15:26:39 -07:00
|
|
|
[[ml-delete-datafeed]]
|
2017-12-14 10:52:49 -08:00
|
|
|
=== Delete {dfeeds-cap} API
|
|
|
|
++++
|
|
|
|
<titleabbrev>Delete {dfeeds-cap}</titleabbrev>
|
|
|
|
++++
|
2017-04-04 15:26:39 -07:00
|
|
|
|
2018-01-15 08:44:08 -08:00
|
|
|
This API enables you to delete an existing {dfeed}.
|
2017-04-04 15:26:39 -07:00
|
|
|
|
2017-04-25 14:08:29 -07:00
|
|
|
|
2017-06-06 13:42:47 -07:00
|
|
|
==== Request
|
2017-04-04 15:26:39 -07:00
|
|
|
|
|
|
|
`DELETE _xpack/ml/datafeeds/<feed_id>`
|
|
|
|
|
2017-04-25 14:08:29 -07:00
|
|
|
|
2017-06-06 13:42:47 -07:00
|
|
|
==== Description
|
2017-04-04 15:26:39 -07:00
|
|
|
|
2017-06-06 13:39:36 +01:00
|
|
|
NOTE: Unless the `force` parameter is used, the {dfeed} must be stopped before it can be deleted.
|
2017-04-04 15:26:39 -07:00
|
|
|
|
2017-04-18 15:13:21 -07:00
|
|
|
|
2017-06-06 13:42:47 -07:00
|
|
|
==== Path Parameters
|
2017-04-04 15:26:39 -07:00
|
|
|
|
|
|
|
`feed_id` (required)::
|
2017-05-02 12:45:42 -07:00
|
|
|
(string) Identifier for the {dfeed}
|
2017-04-04 15:26:39 -07:00
|
|
|
|
2017-04-25 14:08:29 -07:00
|
|
|
|
2017-06-06 13:39:36 +01:00
|
|
|
===== Query Parameters
|
|
|
|
|
|
|
|
`force`::
|
|
|
|
(boolean) Use to forcefully delete a started {dfeed}; this method is quicker than
|
|
|
|
stopping and deleting the {dfeed}.
|
|
|
|
|
2017-06-06 13:42:47 -07:00
|
|
|
|
2017-04-25 14:08:29 -07:00
|
|
|
===== Authorization
|
|
|
|
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
2017-06-19 18:23:58 -07:00
|
|
|
For more information, see {xpack-ref}/security-privileges.html[Security Privileges].
|
|
|
|
//<<privileges-list-cluster>>.
|
2017-04-25 14:08:29 -07:00
|
|
|
|
|
|
|
|
2017-06-06 13:42:47 -07:00
|
|
|
==== Examples
|
2017-04-04 15:26:39 -07:00
|
|
|
|
2018-02-09 09:16:24 -08:00
|
|
|
The following example deletes the `datafeed-total-requests` {dfeed}:
|
2017-04-04 15:26:39 -07:00
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------------------------------
|
2018-02-09 09:16:24 -08:00
|
|
|
DELETE _xpack/ml/datafeeds/datafeed-total-requests
|
2017-04-04 15:26:39 -07:00
|
|
|
--------------------------------------------------
|
|
|
|
// CONSOLE
|
2018-02-09 09:16:24 -08:00
|
|
|
// TEST[setup:server_metrics_datafeed]
|
2017-04-04 15:26:39 -07:00
|
|
|
|
2017-05-02 12:45:42 -07:00
|
|
|
When the {dfeed} is deleted, you receive the following results:
|
2017-04-21 11:23:27 -04:00
|
|
|
[source,js]
|
2017-04-04 15:26:39 -07:00
|
|
|
----
|
|
|
|
{
|
|
|
|
"acknowledged": true
|
|
|
|
}
|
|
|
|
----
|
2018-02-09 09:16:24 -08:00
|
|
|
// TESTRESPONSE
|