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

indices.close

edit

indices.close

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

Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.

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

Params

timeout

DurationString — Explicit operation timeout

masterTimeout

DurationString — Specify timeout for connection to master

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"

waitForActiveShards

String — Sets the number of active shards to wait for before the operation returns.

index

String, String[], Boolean — A comma separated list of indices to close

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.clearCache indices.create »