﻿---
title: stack es field-caps cli command
description: Get the field capabilities. Behaviour flags: --dry-run — validate all inputs and exit without performing any action 
url: https://www.elastic.co/elastic/docs-builder/docs/4118/reference/elastic-cli/cli/stack/es/field-caps
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Preview
---

# stack es field-caps cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es field-caps [options]
```

Get the field capabilities.
**Behaviour flags:**
`--dry-run` — validate all inputs and exit without performing any action

## Options

<definitions>
  <definition term="--allow-no-indices">
    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.
  </definition>
  <definition term="--expand-wildcards enum">
    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`.
    **Values:** all, open, closed, hidden, none
    **Repeatable:** pass `--expand-wildcards` multiple times to supply more than one value
  </definition>
  <definition term="--fields string">
    A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.
    **Repeatable:** pass `--fields` multiple times to supply more than one value
  </definition>
  <definition term="--ignore-unavailable">
    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.
  </definition>
  <definition term="--include-unmapped">
    If true, unmapped fields are included in the response.
  </definition>
  <definition term="--filters string">
    A comma-separated list of filters to apply to the response.
    **Repeatable:** pass `--filters` multiple times to supply more than one value
  </definition>
  <definition term="--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.
    **Repeatable:** pass `--types` multiple times to supply more than one value
  </definition>
  <definition term="--include-empty-fields">
    If false, empty fields are not included in the response.
  </definition>
  <definition term="--index-filter string">
    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.
  </definition>
  <definition term="--runtime-mappings string">
    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.
  </definition>
  <definition term="--index 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.
    **Repeatable:** pass `--index` multiple times to supply more than one value
  </definition>
  <definition term="--error-trace">
    When set to `true` Elasticsearch will include the full stack trace of errors
    when they occur.
  </definition>
  <definition term="--filter-path string">
    Comma-separated list of filters in dot notation which reduce the response
    returned by Elasticsearch.
    **Repeatable:** pass `--filter-path` multiple times to supply more than one value
  </definition>
  <definition term="--human">
    When set to `true` will return statistics in a format suitable for humans.
    For example `"exists_time": "1h"` for humans and
    `"exists_time_in_millis": 3600000` for computers. When disabled the human
    readable values will be omitted. This makes sense for responses being consumed
    only by machines.
  </definition>
  <definition term="--pretty">
    If set to `true` the returned JSON will be "pretty-formatted". Only use
    this option for debugging only.
  </definition>
  <definition term="--input-file string">
    path to a JSON file to use as command input
  </definition>
  <definition term="--dry-run">
    validate all inputs and exit without performing any action (preview changes without applying them)
  </definition>
</definitions>


## Global Options

<definitions>
  <definition term="--json">
    output as JSON
  </definition>
</definitions>