New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Enrich APIs Delete enrich policy API »
Elastic Docs ›Elasticsearch Guide [7.8] ›REST APIs ›Enrich APIs

Put enrich policy API

edit

Put enrich policy API

edit

Creates an enrich policy.

PUT /_enrich/policy/my-policy
{
  "match": {
    "indices": "users",
    "match_field": "email",
    "enrich_fields": ["first_name", "last_name", "city", "zip", "state"]
  }
}
Copy as curlTry in Elastic 

Request

edit

PUT /_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 put enrich policy API to create a new enrich policy.

Once created, you can’t update or change an enrich policy. Instead, you can:

  1. Create and execute a new enrich policy.
  2. Replace the previous enrich policy with the new enrich policy in any in-use enrich processors.
  3. Use the delete enrich policy API to delete the previous enrich policy.

Path parameters

edit
<enrich-policy>
(Required, string) Enrich policy name used to limit the request.

Request body

edit
<policy-type>

(Required, enrich policy object) Enrich policy used to match and add the right enrich data to the right incoming documents.

See Enrich policy definition for object definition and parameters.

« Enrich APIs Delete enrich policy API »

On this page

Was this helpful?
Feedback