IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Delete enrich policy API Execute enrich policy API »

› › ›

Get enrich policy API

edit

Get enrich policy API

edit

Returns information about an enrich policy.

response = client.enrich.get_policy(
  name: 'my-policy'
)
puts response

GET /_enrich/policy/my-policy

Request

edit

GET /_enrich/policy/<name>

GET /_enrich/policy

GET /_enrich/policy/policy1,policy2

Prerequisites

edit

To use enrich policies, you must have:

read index privileges for any indices used
The enrich_user built-in role

Path parameters

edit

<name>

(Optional, string) Comma-separated list of enrich policy names used to limit the request.

To return information for all enrich policies, omit this parameter.

Examples

edit

Get a single policy

edit

response = client.enrich.get_policy(
  name: 'my-policy'
)
puts response

GET /_enrich/policy/my-policy

The API returns the following response:

{
  "policies": [
    {
      "config": {
        "match": {
          "name": "my-policy",
          "indices": [ "users" ],
          "match_field": "email",
          "enrich_fields": [
            "first_name",
            "last_name",
            "city",
            "zip",
            "state"
          ]
        }
      }
    }
  ]
}

Get multiple policies

edit

response = client.enrich.get_policy(
  name: 'my-policy,other-policy'
)
puts response

GET /_enrich/policy/my-policy,other-policy

The API returns the following response:

{
  "policies": [
    {
      "config": {
        "match": {
          "name": "my-policy",
          "indices": [ "users" ],
          "match_field": "email",
          "enrich_fields": [
            "first_name",
            "last_name",
            "city",
            "zip",
            "state"
          ]
        }
      }
    },
    {
      "config": {
        "match": {
          "name": "other-policy",
          "indices": [ "users" ],
          "match_field": "email",
          "enrich_fields": [
            "first_name",
            "last_name",
            "city",
            "zip",
            "state"
          ]
        }
      }
    }
  ]
}

Get all policies

edit

response = client.enrich.get_policy
puts response

GET /_enrich/policy

The API returns the following response:

{
  "policies": [
    {
      "config": {
        "match": {
          "name": "my-policy",
          "indices": [ "users" ],
          "match_field": "email",
          "enrich_fields": [
            "first_name",
            "last_name",
            "city",
            "zip",
            "state"
          ]
        }
      }
    },
    {
      "config": {
        "match": {
          "name": "other-policy",
          "indices": [ "users" ],
          "match_field": "email",
          "enrich_fields": [
            "first_name",
            "last_name",
            "city",
            "zip",
            "state"
          ]
        }
      }
    }
  ]
}

« Delete enrich policy API Execute enrich policy API »