Get filters API
Retrieves filters.
Request
GET _ml/filters/<filter_id>
GET _ml/filters/
Prerequisites
Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.
Description
You can get a single filter or all filters. For more information, see 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. Defaults to
0. -
size - (Optional, integer) Specifies the maximum number of filters to obtain. Defaults to
100.
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
resp = client.ml.get_filters(
filter_id="safe_domains",
)
print(resp) response = client.ml.get_filters( filter_id: 'safe_domains' ) puts response
const response = await client.ml.getFilters({
filter_id: "safe_domains",
});
console.log(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"
]
}
]
}
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-filter.html