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.deleteTemplate indices.existsAlias »
Elastic Docs ›elasticsearch.js ›7.3 API

indices.exists

edit

indices.exists

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

Return a boolean indicating whether given index exists.

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

Params

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.

index

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

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

« indices.deleteTemplate indices.existsAlias »