Execute enrich policy API
editExecute enrich policy API
editExecutes an existing enrich policy.
PUT /_enrich/policy/my-policy/_execute
Request
editPUT /_enrich/policy/<enrich-policy>/_execute
POST /_enrich/policy/<enrich-policy>/_execute
Prerequisites
editIf you use Elasticsearch security features, you must have:
-
readindex privileges for any indices used -
The
enrich_userbuilt-in role
Description
editUse 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 and deletes the previous enrich index.
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 totrue.