Create a filter
Generally available; Added in 5.4.0
A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
Specifically, filters are referenced in the custom_rules
property of detector configuration objects.
Required authorization
- Cluster privileges:
manage_ml
Path parameters
-
filter_id
string Required A string that uniquely identifies a filter.
Body
Required
-
description
string A description of the filter.
-
items
array[string] The items of the filter. A wildcard
*
can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
PUT
/_ml/filters/{filter_id}
Console
PUT _ml/filters/safe_domains
{
"description": "A list of safe domains",
"items": ["*.google.com", "wikipedia.org"]
}
curl \
--request PUT 'http://api.example.com/_ml/filters/{filter_id}' \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/json" \
--data '"{\n \"description\": \"A list of safe domains\",\n \"items\": [\"*.google.com\", \"wikipedia.org\"]\n}"'
Request example
An example body for a `PUT _ml/filters/safe_domains` request.
{
"description": "A list of safe domains",
"items": ["*.google.com", "wikipedia.org"]
}