IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get enrich policy API Enrich stats API »

› › ›

Execute enrich policy API

edit

Execute enrich policy API

edit

Executes an existing enrich policy.

response = client.enrich.execute_policy(
  name: 'my-policy'
)
puts response

PUT /_enrich/policy/my-policy/_execute

Request

edit

PUT /_enrich/policy/<enrich-policy>/_execute

POST /_enrich/policy/<enrich-policy>/_execute

Prerequisites

edit

If you use Elasticsearch security features, you must have:

read index privileges for any indices used
The enrich_user built-in role

Description

edit

Use the execute enrich policy API to create the enrich index for an existing enrich policy.

The enrich index contains documents from the policy’s source indices. Enrich indices always begin with .enrich-*, are read-only, and are force merged.

Enrich indices should be used by the enrich processor only. Avoid using enrich indices for other purposes.

Once created, you cannot update or index documents to an enrich index. Instead, update your source indices and execute the enrich policy again. This creates a new enrich index from your updated source indices. The previous enrich index will deleted with a delayed maintenance job. By default this is done every 15 minutes.

Because this API request performs several operations, it may take a while to return a response.

Path parameters

edit

<enrich-policy>: (Required, string) Enrich policy to execute.

Query parameters

edit

wait_for_completion: (Required, Boolean) If true, the request blocks other enrich policy execution requests until complete. Defaults to true.

« Get enrich policy API Enrich stats API »