Run an enrich policy

Auth

Create the enrich index for an existing enrich policy.

Required privileges

master_timeout union oneOf · default: 30s: Period to wait for a connection to the master node.; Values: -1 0
wait_for_completion boolean · default: true: If true, the request blocks other enrich policy execution requests until complete.

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

{
  "status": {
    "phase": "SCHEDULED",
    "step": "string"
  },
  "task": "string"
}

Generated from the API spec