Run an enrich policy

PUT /_enrich/policy/{name}/_execute

Create the enrich index for an existing 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

PUT /_enrich/policy/my-policy/_execute?wait_for_completion=false

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.enrich.execute_policy(
    name="my-policy",
    wait_for_completion=False,
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_enrich/policy/my-policy/_execute?wait_for_completion=false" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.enrich().executePolicy(e -> e
    .name("my-policy")
    .waitForCompletion(false)
);

C# Elasticsearch .NET Client

var response = await client.Enrich
    .ExecutePolicyAsync(name: "my-policy", d1 => d1
        .WaitForCompletion(false)
    );

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

response = client.enrich.execute_policy(
  name: "my-policy",
  wait_for_completion: "false"
)

Response

No example