12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455 |
- [role="xpack"]
- [[ml-delete-datafeed]]
- = Delete {dfeeds} API
- [subs="attributes"]
- ++++
- <titleabbrev>Delete {dfeeds}</titleabbrev>
- ++++
- Deletes an existing {dfeed}.
- [[ml-delete-datafeed-request]]
- == {api-request-title}
- `DELETE _ml/datafeeds/<feed_id>`
- [[ml-delete-datafeed-prereqs]]
- == {api-prereq-title}
- * Requires the `manage_ml` cluster privilege. This privilege is included in the
- `machine_learning_admin` built-in role.
- * Unless you use the `force` parameter, you must stop the {dfeed} before you
- can delete it.
- [[ml-delete-datafeed-path-parms]]
- == {api-path-parms-title}
- `<feed_id>`::
- (Required, string)
- include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
- [[ml-delete-datafeed-query-parms]]
- == {api-query-parms-title}
- `force`::
- (Optional, Boolean) Use to forcefully delete a started {dfeed}; this method is
- quicker than stopping and deleting the {dfeed}.
- [[ml-delete-datafeed-example]]
- == {api-examples-title}
- [source,console]
- --------------------------------------------------
- DELETE _ml/datafeeds/datafeed-total-requests
- --------------------------------------------------
- // TEST[skip:setup:server_metrics_datafeed]
- When the {dfeed} is deleted, you receive the following results:
- [source,console-result]
- ----
- {
- "acknowledged": true
- }
- ----
|