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 forecasts API »

› › ›

Delete filters API

edit

Delete filters API

edit

Deletes a filter.

Request

edit

DELETE _ml/filters/<filter_id>

Prerequisites

edit

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

Description

edit

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

edit

<filter_id>: (Required, string) A string that uniquely identifies a filter.

Examples

edit

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

DELETE _ml/filters/safe_domains

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

{
  "acknowledged": true
}

« Delete events from calendar API Delete forecasts API »