Get mapping definitions
Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.
This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.
Path parameters
-
Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards (
*
).
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
. Valid values are:all
,open
,closed
,hidden
,none
. -
include_defaults boolean
If
true
, return all default settings in the response. -
local boolean
If
true
, the request retrieves information from the local node only.
curl \
-X GET http://api.example.com/_mapping/field/{fields}
{
"additionalProperty1": {
"mappings": {
"additionalProperty1": {
"full_name": "string",
"mapping": {}
},
"additionalProperty2": {
"full_name": "string",
"mapping": {}
}
}
},
"additionalProperty2": {
"mappings": {
"additionalProperty1": {
"full_name": "string",
"mapping": {}
},
"additionalProperty2": {
"full_name": "string",
"mapping": {}
}
}
}
}