IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete events from calendar API Delete forecast API »
Elastic Docs ›Elasticsearch Guide [7.4] ›REST APIs ›Machine learning anomaly detection APIs

Delete filter API

edit

Delete filter API

edit

Deletes a filter.

Request

edit

DELETE _ml/filters/<filter_id>

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have manage_ml or manage cluster privileges to use this API. See Security privileges.

Description

edit

This API deletes a filter. If a machine learning job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter.

Path parameters

edit
<filter_id>
(Required, string) Identifier for the filter.

Examples

edit

The following example deletes the safe_domains filter:

DELETE _ml/filters/safe_domains

When the filter is deleted, you receive the following results:

{
  "acknowledged": true
}
« Delete events from calendar API Delete forecast API »