This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Update filters API
editUpdate filters API
editUpdates the description of a filter, adds items, or removes items.
Request
editPOST _ml/filters/<filter_id>/_update
Prerequisites
editRequires the manage_ml
cluster privilege. This privilege is included in the
machine_learning_admin
built-in role.
Path parameters
edit-
<filter_id>
- (Required, string) A string that uniquely identifies a filter.
Request body
edit-
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
editresp = client.ml.update_filter( filter_id="safe_domains", description="Updated list of domains", add_items=[ "*.myorg.com" ], remove_items=[ "wikipedia.org" ], ) print(resp)
response = client.ml.update_filter( filter_id: 'safe_domains', body: { description: 'Updated list of domains', add_items: [ '*.myorg.com' ], remove_items: [ 'wikipedia.org' ] } ) puts response
const response = await client.ml.updateFilter({ filter_id: "safe_domains", description: "Updated list of domains", add_items: ["*.myorg.com"], remove_items: ["wikipedia.org"], }); console.log(response);
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"] }