Execute enrich policy API
Executes an existing enrich policy.
PUT /_enrich/policy/my-policy/_execute
Request
PUT /_enrich/policy/<enrich-policy>/_execute
POST /_enrich/policy/<enrich-policy>/_execute
Prerequisites
If you use Elasticsearch security features, you must have:
-
readindex privileges for any indices used - The
enrich_userbuilt-in role
Description
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
-
<enrich-policy> - (Required, string) Enrich policy to execute.
Query parameters
-
wait_for_completion - (Required, Boolean) If
true, the request blocks other enrich policy execution requests until complete. Defaults totrue.
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/execute-enrich-policy-api.html
