Create an enrich policy | Elasticsearch API (v8)

Create an enrich policy Added in 7.5.0

PUT /_enrich/policy/{name}

Creates an enrich policy.

Path parameters

name string Required

Name of the enrich policy to create or update.

application/json

Body Required

geo_match object Additional properties

Additional properties are allowed.
Hide geo_match attributes Show geo_match attributes object
- enrich_fields string | array[string] Required
- indices string | array[string] Required
- match_field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
- query object
  
  Additional properties are allowed.
  
  External documentation
- name string
- elasticsearch_version string
match object Additional properties

Additional properties are allowed.
Hide match attributes Show match attributes object
- enrich_fields string | array[string] Required
- indices string | array[string] Required
- match_field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
- query object
  
  Additional properties are allowed.
  
  External documentation
- name string
- elasticsearch_version string
range object Additional properties

Additional properties are allowed.
Hide range attributes Show range attributes object
- enrich_fields string | array[string] Required
- indices string | array[string] Required
- match_field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
- query object
  
  Additional properties are allowed.
  
  External documentation
- name string
- elasticsearch_version string

Responses

200 application/json
Hide response attribute Show response attribute object
- acknowledged boolean Required
  
  For a successful response, this value is always true. On failure, an exception is returned instead.

PUT /_enrich/policy/{name}

curl \
 -X PUT http://api.example.com/_enrich/policy/{name} \
 -H "Content-Type: application/json" \
 -d '{"additionalProperty1":{"enrich_fields":"string","indices":"string","match_field":"string","query":{},"name":"string","elasticsearch_version":"string"},"additionalProperty2":{"enrich_fields":"string","indices":"string","match_field":"string","query":{},"name":"string","elasticsearch_version":"string"}}'

Request examples

{
  "additionalProperty1": {
    "enrich_fields": "string",
    "indices": "string",
    "match_field": "string",
    "query": {},
    "name": "string",
    "elasticsearch_version": "string"
  },
  "additionalProperty2": {
    "enrich_fields": "string",
    "indices": "string",
    "match_field": "string",
    "query": {},
    "name": "string",
    "elasticsearch_version": "string"
  }
}

Response examples (200)

{
  "acknowledged": true
}