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.forcemerge indices.getAlias »
Elastic Docs ›elasticsearch.js ›6.8 API

indices.get

edit

indices.get

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

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: true)

local

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

ignoreUnavailable

Boolean — Ignore unavailable indexes (default: false)

allowNoIndices

Boolean — Ignore if a wildcard expression resolves to no concrete indices (default: false)

[expandWildcards=open]

String — Whether wildcard expressions should get expanded to open or closed indices (default: open)

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

flatSettings

Boolean — Return settings in flat format (default: false)

includeDefaults

Boolean — Whether to return all default setting for each of the indices.

masterTimeout

DurationString — Specify timeout for connection to master

index

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

back to top

« indices.forcemerge indices.getAlias »