Delete filters API
- Delete filters API

Delete filters API

New API reference

For the most up-to-date API details, refer to Machine learning anomaly detection APIs.

Deletes a filter.

Request

DELETE _ml/filters/<filter_id>

Prerequisites

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

Description

This API deletes a filter. If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter. For more information, see Custom rules.

Path parameters

<filter_id>

(Required, string) A string that uniquely identifies a filter.

Examples

resp = client.ml.delete_filter(
    filter_id="safe_domains",
)
print(resp)

response = client.ml.delete_filter(
  filter_id: 'safe_domains'
)
puts response

const response = await client.ml.deleteFilter({
  filter_id: "safe_domains",
});
console.log(response);

DELETE _ml/filters/safe_domains

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

{
  "acknowledged": true
}