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 API
editRetrieves filters.
Prerequisites
edit-
You must have
monitor_ml
,monitor
,manage_ml
, ormanage
cluster privileges to use this API. For more information, see Security privileges.
Description
editYou 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.
Query parameters
edit-
from
- (integer) Skips the specified number of filters.
-
size
- (integer) Specifies the maximum number of filters to obtain.
Response body
editThe API returns the following information:
-
filters
- (array) An array of filter resources. For more information, see Filter resources.
Examples
editThe 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" ] } ] }