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 API
editGet filters APIedit
Retrieves filters.
Prerequisitesedit
Requires the manage_ml
cluster privilege. This privilege is included in the
machine_learning_admin
built-in role.
Descriptionedit
You can get a single filter or all filters. For more information, see Custom rules.
Path parametersedit
-
<filter_id>
- (Optional, string) A string that uniquely identifies a filter.
Query parametersedit
-
from
-
(Optional, integer) Skips the specified number of filters. Defaults to
0
. -
size
-
(Optional, integer) Specifies the maximum number of filters to obtain.
Defaults to
100
.
Response bodyedit
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.
Examplesedit
response = client.ml.get_filters( filter_id: 'safe_domains' ) puts response
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" ] } ] }