IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create enrich policy API Get enrich policy API »
Elastic Docs ›Elasticsearch Guide [8.8] ›REST APIs ›Enrich APIs

Delete enrich policy API

edit

Delete enrich policy API

edit

Deletes an existing enrich policy and its enrich index.

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

Request

edit

DELETE /_enrich/policy/<enrich-policy>

Prerequisites

edit

If you use Elasticsearch security features, 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 »