Get mapping definitions

GET /{index}/_mapping/field/{fields}
Api key auth Basic auth Bearer auth

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

  • index string | array[string] Required

    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.

  • fields string | array[string] Required

    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.

  • ignore_unavailable boolean

    If false, the request returns an error if it targets a missing or closed index.

  • include_defaults boolean

    If true, return all default settings in the response.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • * object Additional properties

      Additional properties are allowed.

      Hide * attribute Show * attribute object
      • mappings object Required
        Hide mappings attribute Show mappings attribute object
        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object
GET /{index}/_mapping/field/{fields} 
curl \
 --request GET http://api.example.com/{index}/_mapping/field/{fields} \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "additionalProperty1": {
    "mappings": {
      "additionalProperty1": {
        "full_name": "string",
        "mapping": {}
      },
      "additionalProperty2": {
        "full_name": "string",
        "mapping": {}
      }
    }
  },
  "additionalProperty2": {
    "mappings": {
      "additionalProperty1": {
        "full_name": "string",
        "mapping": {}
      },
      "additionalProperty2": {
        "full_name": "string",
        "mapping": {}
      }
    }
  }
}