Get an enrich policy

GET /_enrich/policy/{name}
GET /_enrich/policy

Auth

Returns information about an enrich policy.

Required privileges

Cluster privileges monitor_enrich manage_enrich

Path parameters

name union string | string[] optional

Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter.

Leave it out to use /_enrich/policy.

Query parameters

master_timeout union oneOf · default: 30s: Period to wait for a connection to the master node.; Values: -1 0

Response

application/json

policies object[] required

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_enrich/policy/my-policy

JavaScript Elasticsearch JavaScript Client

const response = await client.enrich.getPolicy({
  name: "my-policy",
});

Python Elasticsearch Python Client

resp = client.enrich.get_policy(
    name="my-policy",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_enrich/policy/my-policy" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.enrich().getPolicy(g -> g
    .name("my-policy")
);

C# Elasticsearch .NET Client

var response = await client.Enrich
    .GetPolicyAsync(d1 => d1
        .Name(new[] { "my-policy" })
    );

PHP Elasticsearch PHP Client

$resp = $client->enrich()->getPolicy([
    "name" => "my-policy",
]);

Ruby Elasticsearch Ruby Client

response = client.enrich.get_policy(
  name: "my-policy"
)

Response

{
  "policies": [
    {
      "config": {
        "key": {
          "match_field": "string",
          "query": {},
          "name": "string",
          "elasticsearch_version": "string"
        }
      }
    }
  ]
}

Generated from the API spec