Get the field capabilities

POST also GET /{index}/_field_caps
POST also GET /_field_caps

Get information about the capabilities of fields among multiple indices.

For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family.

Required authorization

Index privileges: view_index_metadata,read

Path Parameters

index union IndexName | [] IndexName optional

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Leave it out to use /_field_caps.

Query Parameters

allow_no_indices boolean · default: true

A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

expand_wildcards string ExpandWildcards · default: open

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

fields union Fields

A comma-separated list of fields to retrieve capabilities for. Wildcard (*) expressions are supported.

One of: Field or Field[]

ignore_unavailable boolean · default: false

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

include_unmapped boolean · default: false

If true, unmapped fields are included in the response.

filters union string | [] string

A comma-separated list of filters to apply to the response.

One of: string or string[]

types [] string

A comma-separated list of field types to include. Any fields that do not match one of these types will be excluded from the results. It defaults to empty, meaning that all field types are returned.

include_empty_fields boolean · default: true

If false, empty fields are not included in the response.

Request

Response

application/json

Examples

Run POST my-index-*/_field_caps?fields=rating to get field capabilities and filter indices with a query. Indices that rewrite the provided filter to match_none on every shard will be filtered from the response.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST my-index-*/_field_caps?fields=rating
{
  "index_filter": {
    "range": {
      "@timestamp": {
        "gte": "2018"
      }
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.fieldCaps({
  index: "my-index-*",
  fields: "rating",
  index_filter: {
    range: {
      "@timestamp": {
        gte: "2018",
      },
    },
  },
});

Python Elasticsearch Python Client

resp = client.field_caps(
    index="my-index-*",
    fields="rating",
    index_filter={
        "range": {
            "@timestamp": {
                "gte": "2018"
            }
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-*/_field_caps?fields=rating" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "index_filter": {
      "range": {
        "@timestamp": {
          "gte": "2018"
        }
      }
    }
  }'

Java Elasticsearch Java Client

client.fieldCaps(f -> f
    .fields("rating")
    .index("my-index-*")
    .indexFilter(i -> i
        .range(r -> r
            .untyped(u -> u
                .field("@timestamp")
                .gte(JsonData.fromJson("\"2018\""))
            )
        )
    )
);

C# Elasticsearch .NET Client

var response = await client
    .FieldCapsAsync(d1 => d1
        .Indices(new[] { "my-index-*" })
        .IndexFilter(d2 => d2
            .Range(new UntypedRangeQuery()
            {
                Field = global::Elastic.Clients.Elasticsearch.Infer.Field<MyDocument>(x => x.Timestamp),
                Gte = "2018"
            })
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->fieldCaps([
    "index" => "my-index-*",
    "fields" => "rating",
    "body" => [
        "index_filter" => [
            "range" => [
                "@timestamp" => [
                    "gte" => "2018",
                ],
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.field_caps(
  index: "my-index-*",
  fields: "rating",
  body: {
    "index_filter": {
      "range": {
        "@timestamp": {
          "gte": "2018"
        }
      }
    }
  }
)

Response

{
  "indices": [ "index1", "index2", "index3", "index4", "index5" ],
  "fields": {
    "rating": {
      "long": {
        "metadata_field": false,
        "searchable": true,
        "aggregatable": false,
        "inference": false,
        "indices": [ "index1", "index2" ],
        "non_aggregatable_indices": [ "index1" ]
      },
      "keyword": {
        "metadata_field": false,
        "searchable": false,
        "aggregatable": true,
        "inference": false,
        "indices": [ "index3", "index4" ],
        "non_searchable_indices": [ "index4" ]
      }
    },
    "title": {
      "text": {
        "metadata_field": false,
        "searchable": true,
        "aggregatable": false,
        "inference": false
      }
    }
  }
}

Required authorization

Path Parameters

Query Parameters { allow_no_indices , expand_wildcards , fields , ignore_unavailable , include_unmapped , filters , types , include_empty_fields , }

Request { fields , index_filter , runtime_mappings , }

Response

Query Parameters

Request