IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« indices.getFieldMapping indices.getSettings »
Elastic Docs ›elasticsearch.js ›7.4 API

indices.getMapping

edit

indices.getMapping

edit
client.indices.getMapping([params, [callback]])

Retrieve mapping definition of index or index/type.

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

includeTypeName

Boolean — Whether to add the type name to the response (default: false)

ignoreUnavailable

Boolean — Whether specified concrete indices should be ignored when unavailable (missing or closed)

allowNoIndices

Boolean — Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

[expandWildcards=open]

String — Whether to expand wildcard expression to concrete indices that are open, closed or both.

Options
  • "open"
  • "closed"
  • "none"
  • "all"

masterTimeout

DurationString — Specify timeout for connection to master

local

Boolean — Return local information, do not retrieve the state from master node (default: false)

index

String, String[], Boolean — A comma-separated list of index names

type

String, String[], Boolean — A comma-separated list of document types

back to top

« indices.getFieldMapping indices.getSettings »