Create filters APIedit
Instantiates a filter.
Requestedit
PUT _ml/filters/<filter_id>
Prerequisitesedit
Requires the manage_ml
cluster privilege. This privilege is included in the
machine_learning_admin
built-in role.
Descriptionedit
A filter contains a list of strings. It can be used by one or more jobs.
Specifically, filters are referenced in the custom_rules
property of detector
configuration objects. For more information, see
Custom rules.
Path parametersedit
-
<filter_id>
- (Required, string) A string that uniquely identifies a filter.
Request bodyedit
-
description
- (Optional, string) A description of the filter.
-
items
-
(Required, array of strings) 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.
Examplesedit
PUT _ml/filters/safe_domains { "description": "A list of safe domains", "items": ["*.google.com", "wikipedia.org"] }
When the filter is created, you receive the following response:
{ "filter_id": "safe_domains", "description": "A list of safe domains", "items": ["*.google.com", "wikipedia.org"] }