Get terms in an index

POST also GET /{index}/_terms_enum

Discover terms that match a partial string in an index. This API is designed for low-latency look-ups used in auto-complete scenarios.

Note

The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Request Console 1 / 8 languages

Run POST stackoverflow/_terms_enum.

Console Kibana Dev Tools

POST stackoverflow/_terms_enum
{
    "field" : "tags",
    "string" : "kiba"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.termsEnum({
  index: "stackoverflow",
  field: "tags",
  string: "kiba",
});

Python Elasticsearch Python Client

resp = client.terms_enum(
    index="stackoverflow",
    field="tags",
    string="kiba",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/stackoverflow/_terms_enum" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "field": "tags",
    "string": "kiba"
  }'

Java Elasticsearch Java Client

client.termsEnum(t -> t
    .field("tags")
    .index("stackoverflow")
    .string("kiba")
);

C# Elasticsearch .NET Client

var response = await client
    .TermsEnumAsync(index: "stackoverflow", d1 => d1
        .Field(x => x.Tags)
        .String("kiba")
    );

PHP Elasticsearch PHP Client

$resp = $client->termsEnum([
    "index" => "stackoverflow",
    "body" => [
        "field" => "tags",
        "string" => "kiba",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.terms_enum(
  index: "stackoverflow",
  body: {
    "field": "tags",
    "string": "kiba"
  }
)

Response

A successful response from POST stackoverflow/_terms_enum.

{
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "terms": [
    "kibana"
  ],
  "complete" : true
}

Get terms in an index

Authentication

Path parameters

Request body

Response

Authentication

Path parameters

Request body { }

Response

Request body