NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Get scheduled events API Get records API »
Elastic Docs ›Elasticsearch Guide [6.8] ›X-Pack APIs ›Machine learning APIs

Get filters API

edit

Get filters API

edit

Retrieves filters.

Request

edit

GET _xpack/ml/filters/<filter_id>

GET _xpack/ml/filters/

Description

edit

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

Path Parameters

edit
filter_id
(string) Identifier for the filter.

Querystring Parameters

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

Results

edit

The API returns the following information:

filters
(array) An array of filter resources. For more information, see Filter resources.

Authorization

edit

You must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. For more information, see Security privileges.

Examples

edit

The following example gets configuration information for the safe_domains filter:

GET _xpack/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"
      ]
    }
  ]
}
« Get scheduled events API Get records API »