Get filters

GET /_ml/filters/{filter_id}
GET /_ml/filters

Auth

You can get a single filter or all filters.

Required privileges

Cluster privileges manage_ml

Path parameters

filter_id union string | string[] optional

A string that uniquely identifies a filter.

Leave it out to use /_ml/filters.

Query parameters

from number · default: 0: Skips the specified number of filters.
size number · default: 100: Specifies the maximum number of filters to obtain.

Response

application/json

count number required
filters object[] required

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _ml/filters/safe_domains

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.getFilters({
  filter_id: "safe_domains",
});

Python Elasticsearch Python Client

resp = client.ml.get_filters(
    filter_id="safe_domains",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_ml/filters/safe_domains" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().getFilters(g -> g
    .filterId("safe_domains")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .GetFiltersAsync(d1 => d1
        .FilterId(new[] { "safe_domains" })
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->getFilters([
    "filter_id" => "safe_domains",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.get_filters(
  filter_id: "safe_domains"
)

Response

{
  "count": 0,
  "filters": [
    {
      "description": "string",
      "filter_id": "string",
      "items": [
        "string"
      ]
    }
  ]
}

Generated from the API spec