# Get mapping definitions


**GET /{index}/_mapping**

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

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

For data streams, the API retrieves mappings for the stream’s backing indices.

## Required authorization

* Index privileges: `view_index_metadata`



## 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])
  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)
  If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
  This behavior applies even if the request targets other open indices.
- **expand_wildcards** (string | array[string])
  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.

- **ignore_unavailable** (boolean)
  If `false`, the request returns an error if it targets a missing or closed index.
- **local** (boolean)
  If `true`, the request retrieves information from the local node only.
- **master_timeout** (string)
  Period to wait for a connection to the master node.
  If no response is received before the timeout expires, the request fails and returns an error.


## Responses
### 200


#### Body: application/json (object)
- ***** (object)



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