NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Update filter API
editUpdate filter API
editUpdates the description of a filter, adds items, or removes items.
Request
editPOST _xpack/ml/filters/<filter_id>/_update
Path Parameters
edit-
filter_id(required) - (string) Identifier for the filter.
Request Body
edit-
description - (string) A description for the filter. See Filter resources.
-
add_items - (array of strings) The items to add to the filter.
-
remove_items - (array of strings) The items to remove from the filter.
Authorization
editYou must have manage_ml, or manage cluster privileges to use this API.
For more information, see
Security privileges.
Examples
editYou can change the description, add and remove items to the safe_domains filter as follows:
POST _xpack/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"]
}