Update a filter | Elasticsearch API documentation

Update a filter 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.

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

curl \
 --request POST http://api.example.com/_ml/filters/{filter_id}/_update \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"add_items":["string"],"description":"string","remove_items":["string"]}'

Request examples

{
  "add_items": [
    "string"
  ],
  "description": "string",
  "remove_items": [
    "string"
  ]
}

Response examples (200)

{
  "description": "string",
  "filter_id": "string",
  "items": [
    "string"
  ]
}