Delete a filter

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 privileges

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _ml/filters/safe_domains

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_ml/filters/safe_domains" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().deleteFilter(d -> d
    .filterId("safe_domains")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.DeleteFilterAsync(filterId: "safe_domains");

PHP Elasticsearch PHP Client

$resp = $client->ml()->deleteFilter([
    "filter_id" => "safe_domains",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.delete_filter(
  filter_id: "safe_domains"
)

Response

A successful response when deleting a filter.

{
  "acknowledged": true
}