This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Create enrich policy API Get enrich policy API »

› › ›

Delete enrich policy API

edit

Delete enrich policy API

edit

Deletes an existing enrich policy and its enrich index.

resp = client.enrich.delete_policy(
    name="my-policy",
)
print(resp)

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

const response = await client.enrich.deletePolicy({
  name: "my-policy",
});
console.log(response);

DELETE /_enrich/policy/my-policy

Request

edit

DELETE /_enrich/policy/<enrich-policy>

Prerequisites

edit

To use enrich policies, you must have:

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

Description

edit

Use the delete enrich policy API to delete an existing enrich policy and its enrich index.

You must remove an enrich policy from any in-use ingest pipelines before deletion. You cannot remove in-use enrich policies.

Path parameters

edit

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

« Create enrich policy API Get enrich policy API »