Create an enrich policy

PUT /_enrich/policy/{name}

Auth

Creates an enrich policy.

Required privileges

Cluster privileges manage_enrich

Path parameters

name string required: Name of the enrich policy to create or update.

Query parameters

master_timeout union oneOf · default: 30s: Period to wait for a connection to the master node.; Values: -1 0

Request body

geo_match object: Matches enrich data to incoming documents based on a geo_shape query.
match object: Matches enrich data to incoming documents based on a term query.
range object: Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a term query.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

An example body for a PUT /_enrich/policy/postal_policy request.

Console Kibana Dev Tools

PUT /_enrich/policy/postal_policy
{
  "geo_match": {
    "indices": "postal_codes",
    "match_field": "location",
    "enrich_fields": [ "location", "postal_code" ]
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.enrich.putPolicy({
  name: "postal_policy",
  geo_match: {
    indices: "postal_codes",
    match_field: "location",
    enrich_fields: ["location", "postal_code"],
  },
});

Python Elasticsearch Python Client

resp = client.enrich.put_policy(
    name="postal_policy",
    geo_match={
        "indices": "postal_codes",
        "match_field": "location",
        "enrich_fields": [
            "location",
            "postal_code"
        ]
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_enrich/policy/postal_policy" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "geo_match": {
      "indices": "postal_codes",
      "match_field": "location",
      "enrich_fields": [
        "location",
        "postal_code"
      ]
    }
  }'

Java Elasticsearch Java Client

client.enrich().putPolicy(p -> p
    .geoMatch(g -> g
        .enrichFields(List.of("location","postal_code"))
        .indices("postal_codes")
        .matchField("location")
    )
    .name("postal_policy")
);

C# Elasticsearch .NET Client

var response = await client.Enrich
    .PutPolicyAsync(name: "postal_policy", d1 => d1
        .GeoMatch(d2 => d2
            .EnrichFields(x => x.Location, x => x.PostalCode)
            .Indices(new[] { "postal_codes" })
            .MatchField(x => x.Location)
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->enrich()->putPolicy([
    "name" => "postal_policy",
    "body" => [
        "geo_match" => [
            "indices" => "postal_codes",
            "match_field" => "location",
            "enrich_fields" => array(
                "location",
                "postal_code",
            ),
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.enrich.put_policy(
  name: "postal_policy",
  body: {
    "geo_match": {
      "indices": "postal_codes",
      "match_field": "location",
      "enrich_fields": [
        "location",
        "postal_code"
      ]
    }
  }
)

Response

{
  "acknowledged": false
}

Generated from the API spec

Required privileges

Path parameters

Query parameters

Request body { }

Response

Request body