# Get the field capabilities


**POST /{index}/_field_caps**

**All methods and paths for this operation:**

<div>
                      <span class="operation-verb get">GET</span>
                      <span class="operation-path">/_field_caps</span>
                      </div>
                    <div>
                      <span class="operation-verb post">POST</span>
                      <span class="operation-path">/_field_caps</span>
                      </div>
                    <div>
                      <span class="operation-verb get">GET</span>
                      <span class="operation-path">/{index}/_field_caps</span>
                      </div>
                    <div>
                      <span class="operation-verb post">POST</span>
                      <span class="operation-path">/{index}/_field_caps</span>
                      </div>
                    

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`



## Servers
- http://api.example.com: http://api.example.com ()


## Authentication methods
- Api key auth
- Basic auth
- Bearer auth


## Parameters

### Path parameters
- **index** (string | array[string])
  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.

### Query parameters
- **allow_no_indices** (boolean)
  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 | array[string])
  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.

- **fields** (string | array[string])
  A comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.
- **ignore_unavailable** (boolean)
  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)
  If true, unmapped fields are included in the response.
- **filters** (string | array[string])
  A comma-separated list of filters to apply to the response.
- **types** (array[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)
  If false, empty fields are not included in the response.

### Body: application/json (object)

- **fields** (string | array[string])
  A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.
- **index_filter** (object)
  Filter indices if the provided query rewrites to `match_none` on every shard.

  IMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request.
  For instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range.
  However, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.
- **runtime_mappings** (object)
  Define ad-hoc runtime fields in the request similar to the way it is done in search requests.
  These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.


## Responses
### 200


#### Body: application/json (object)
- **indices** (string | array[string])
  The list of indices where this field has the same type family, or null if all indices have the same type family for the field.
- **fields** (object)



[Powered by Bump.sh](https://bump.sh)