New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Update datafeeds API Update jobs API »
Elastic Docs ›Elasticsearch Guide [7.1] ›X-Pack APIs ›Machine learning APIs

Update filter API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Update filter API

edit

Updates the description of a filter, adds items, or removes items.

Request

edit

POST _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

edit

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security privileges.

Examples

edit

You can change the description, add and remove items to the safe_domains filter as follows:

POST _ml/filters/safe_domains/_update
{
  "description": "Updated list of domains",
  "add_items": ["*.myorg.com"],
  "remove_items": ["wikipedia.org"]
}
Copy as curlTry in Elastic 

The API returns the following results:

{
  "filter_id": "safe_domains",
  "description": "Updated list of domains",
  "items": ["*.google.com", "*.myorg.com"]
}
« Update datafeeds API Update jobs API »
Was this helpful?
Feedback