Run an enrich policy Generally available; Added in 7.5.0

PUT /_enrich/policy/{name}/_execute

Create the enrich index for an existing enrich policy.

Path parameters

  • name string Required

    Enrich policy to execute.

Query parameters

  • master_timeout string

    Period to wait for a connection to the master node.

    Values are -1 or 0.

  • wait_for_completion boolean

    If true, the request blocks other enrich policy execution requests until complete.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • status object
      Hide status attributes Show status attributes object
      • phase string Required

        Values are SCHEDULED, RUNNING, COMPLETE, FAILED, or CANCELLED.

      • step string

    • task string | number

      One of:
      TaskId string TaskId number
PUT /_enrich/policy/{name}/_execute 
PUT /_enrich/policy/my-policy/_execute?wait_for_completion=false

curl \
 --request PUT 'http://api.example.com/_enrich/policy/{name}/_execute'

Documentation preview

This is a preview of your version @2025-06-09 which is not yet released.

View current documentation