Get filters API

Retrieves filters.

Request

GET _ml/filters/<filter_id>

GET _ml/filters/

Prerequisites

  • If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. See Security privileges.

Description

You can get a single filter or all filters. For more information, see Machine learning custom rules.

Path parameters

<filter_id>
(Optional, string) A string that uniquely identifies a filter.

Query parameters

from
(Optional, integer) Skips the specified number of filters.
size
(Optional, integer) Specifies the maximum number of filters to obtain.

Response body

The API returns an array of filter resources, which have the following properties:

description
(string) A description of the filter.
filter_id
(string) A string that uniquely identifies a filter.
items
(array of strings) An array of strings which is the filter item list.

Examples

GET _ml/filters/safe_domains

The API returns the following results:

{
  "count": 1,
  "filters": [
    {
      "filter_id": "safe_domains",
      "description": "A list of safe domains",
      "items": [
        "*.google.com",
        "wikipedia.org"
      ]
    }
  ]
}