Delete a filter Generally available; Added in 5.4.0

DELETE /_ml/filters/{filter_id}
Api key auth Basic auth Bearer auth

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.

Required authorization

  • Cluster privileges: manage_ml

Path parameters

  • filter_id string Required

    A string that uniquely identifies a filter.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • acknowledged boolean Required

      For a successful response, this value is always true. On failure, an exception is returned instead.
DELETE /_ml/filters/{filter_id} 
DELETE _ml/filters/safe_domains

resp = client.ml.delete_filter(
    filter_id="safe_domains",
)
const response = await client.ml.deleteFilter({
  filter_id: "safe_domains",
});
response = client.ml.delete_filter(
  filter_id: "safe_domains"
)
$resp = $client->ml()->deleteFilter([
    "filter_id" => "safe_domains",
]);
curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/filters/safe_domains"
Response examples (200)
A successful response when deleting a filter. 
{
  "acknowledged": true
}