IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Put enrich policy API
editPut enrich policy API
editCreates an enrich policy.
PUT /_enrich/policy/my-policy { "match": { "indices": "users", "match_field": "email", "enrich_fields": ["first_name", "last_name", "city", "zip", "state"] } }
Request
editPUT /_enrich/policy/<enrich-policy>
Prerequisites
editIf you use Elasticsearch security features, you must have:
-
read
index privileges for any indices used -
The
enrich_user
built-in role
Description
editUse 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:
- Create and execute a new enrich policy.
- Replace the previous enrich policy with the new enrich policy in any in-use enrich processors.
- 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.