Update a filter | Elasticsearch API documentation

Update a filter Generally available; Added in 6.4.0

POST /_ml/filters/{filter_id}/_update

Api key auth Basic auth Bearer auth

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

Required authorization

Cluster privileges: manage_ml

Path parameters

filter_id string Required

A string that uniquely identifies a filter.

application/json

Body Required

add_items array[string]

The items to add to the filter.
description string

A description for the filter.
remove_items array[string]

The items to remove from the filter.

Responses

200 application/json
Hide response attributes Show response attributes object
- description string Required
- filter_id string Required
- items array[string] Required

POST /_ml/filters/{filter_id}/_update

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

curl \
 --request POST 'http://api.example.com/_ml/filters/{filter_id}/_update' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"description\": \"Updated list of domains\",\n  \"add_items\": [\"*.myorg.com\"],\n  \"remove_items\": [\"wikipedia.org\"]\n}"'

Request example

An example body for a `POST _ml/filters/safe_domains/_update` request.

{
  "description": "Updated list of domains",
  "add_items": ["*.myorg.com"],
  "remove_items": ["wikipedia.org"]
}