Update a filter

POST /_ml/filters/{filter_id}/_update

Auth

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

Required privileges

Cluster privileges manage_ml

Path parameters

filter_id string required: A string that uniquely identifies a filter.

Request body

add_items string[]: The items to add to the filter.
description string: A description for the filter.
remove_items string[]: The items to remove from the filter.

Response

application/json

description string required
filter_id string required
items string[] required

View as Markdown

Examples

Request Console 1 / 8 languages

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

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.updateFilter({
  filter_id: "safe_domains",
  description: "Updated list of domains",
  add_items: ["*.myorg.com"],
  remove_items: ["wikipedia.org"],
});

Python Elasticsearch Python Client

resp = client.ml.update_filter(
    filter_id="safe_domains",
    description="Updated list of domains",
    add_items=[
        "*.myorg.com"
    ],
    remove_items=[
        "wikipedia.org"
    ],
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/filters/safe_domains/_update" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated list of domains",
    "add_items": [
      "*.myorg.com"
    ],
    "remove_items": [
      "wikipedia.org"
    ]
  }'

Java Elasticsearch Java Client

client.ml().updateFilter(u -> u
    .addItems("*.myorg.com")
    .description("Updated list of domains")
    .filterId("safe_domains")
    .removeItems("wikipedia.org")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .UpdateFilterAsync(filterId: "safe_domains", d1 => d1
        .AddItems("*.myorg.com")
        .Description("Updated list of domains")
        .RemoveItems("wikipedia.org")
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->updateFilter([
    "filter_id" => "safe_domains",
    "body" => [
        "description" => "Updated list of domains",
        "add_items" => array(
            "*.myorg.com",
        ),
        "remove_items" => array(
            "wikipedia.org",
        ),
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.update_filter(
  filter_id: "safe_domains",
  body: {
    "description": "Updated list of domains",
    "add_items": [
      "*.myorg.com"
    ],
    "remove_items": [
      "wikipedia.org"
    ]
  }
)

Response

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

Generated from the API spec

Required privileges

Path parameters

Request body { }

Response

Request body