Run an enrich policy Generally available; Added in 7.5.0

View as markdown
PUT /_enrich/policy/{name}/_execute
Api key auth Basic auth Bearer auth

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.

    External documentation
  • 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
PUT /_enrich/policy/{name}/_execute 
PUT /_enrich/policy/my-policy/_execute?wait_for_completion=false 
resp = client.enrich.execute_policy( name="my-policy", wait_for_completion=False, )
const response = await client.enrich.executePolicy({ name: "my-policy", wait_for_completion: "false", });
response = client.enrich.execute_policy( name: "my-policy", wait_for_completion: "false" )
$resp = $client->enrich()->executePolicy([ "name" => "my-policy", "wait_for_completion" => "false", ]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_enrich/policy/my-policy/_execute?wait_for_completion=false"