Create filters API

Create filters API

Instantiates a filter.

Request

PUT _ml/filters/<filter_id>

Prerequisites

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

Description

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.

Path parameters

<filter_id>

(Required, string) A string that uniquely identifies a filter.

Request body

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.

Examples

  1. PUT _ml/filters/safe_domains
  2. {
  3.   "description": "A list of safe domains",
  4.   "items": ["*.google.com", "wikipedia.org"]
  5. }

When the filter is created, you receive the following response:

  1. {
  2.   "filter_id": "safe_domains",
  3.   "description": "A list of safe domains",
  4.   "items": ["*.google.com", "wikipedia.org"]
  5. }