Close index

Introduced 1.0

The close index API operation closes an index. Once an index is closed, you cannot add data to it or search for any data within the index.

Path and HTTP methods

POST /<index>/_close

Parameter	Type	Description
<index>	String	The index to close. Can be a comma-separated list of multiple index names. Use `_all` or * to close all indexes.

All parameters are optional.

Parameter	Type	Description
allow_no_indices	Boolean	Whether to ignore wildcards that don’t match any indexes. Default is `true`.
expand_wildcards	String	Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions). Default is `open`.
ignore_unavailable	Boolean	If true, OpenSearch does not search for missing or closed indexes. Default is `false`.
wait_for_active_shards	String	Specifies the number of active shards that must be available before OpenSearch processes the request. Default is 1 (only the primary shard). Set to all or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the request to succeed.
cluster_manager_timeout	Time	How long to wait for a connection to the cluster manager node. Default is `30s`.
timeout	Time	How long to wait for a response from the cluster. Default is `30s`.

POST /sample-index/_close

copy

{
  "acknowledged": true,
  "shards_acknowledged": true,
  "indices": {
    "sample-index1": {
      "closed": true
    }
  }
}