IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get filters APIedit
Retrieves filters.
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
monitor_ml,monitor,manage_ml, ormanagecluster privileges to use this API. See Security privileges.
Descriptionedit
You can get a single filter or all filters. For more information, see Machine learning custom rules.
Path parametersedit
-
<filter_id> - (Optional, string) Identifier for the filter.
Query parametersedit
-
from - (Optional, integer) Skips the specified number of filters.
-
size - (Optional, integer) Specifies the maximum number of filters to obtain.
Response bodyedit
The API returns the following information:
-
filters -
(array) An array of filter resources. A filter resource has the following properties:
-
filter_id - (string) A string that uniquely identifies the filter.
-
description - (string) A description of the filter.
-
items - (array of strings) An array of strings which is the filter item list.
-
Examplesedit
The following example gets configuration information for the safe_domains
filter:
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"
]
}
]
}