Update filter API
Updates the description of a filter, adds items, or removes items.
Request
POST _ml/filters/<filter_id>/_update
Prerequisites
- If the Elasticsearch security features are enabled, you must have
manage_ml
ormanage
cluster privileges to use this API. See Security privileges and Machine learning security privileges.
Path parameters
<filter_id>
(Required, string) A string that uniquely identifies a filter.
Request body
add_items
(Optional, array of strings) The items to add to the filter.
description
(Optional, string) A description for the filter.
remove_items
(Optional, array of strings) The items to remove from the filter.
Examples
POST _ml/filters/safe_domains/_update
{
"description": "Updated list of domains",
"add_items": ["*.myorg.com"],
"remove_items": ["wikipedia.org"]
}
The API returns the following results:
{
"filter_id": "safe_domains",
"description": "Updated list of domains",
"items": ["*.google.com", "*.myorg.com"]
}