Get an enrich policy

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

Returns information about an enrich policy.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

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

No example