Open a closed index | Elasticsearch API documentation (original) (raw)
Dismiss highlight Show more
Path parameters
- index
string | array[string] Required
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*
). By default, you must explicitly name the indices you using to limit the request. To limit a request using_all
,*
, or other wildcard expressions, change theaction.destructive_requires_name
setting to false. You can update this setting in theelasticsearch.yml
file or using the cluster update settings API.
Query parameters
- If
false
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as
open,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.
Supported values include:all
: Match any data stream or index, including hidden ones.open
: Match open, non-hidden indices. Also matches any non-hidden data stream.closed
: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.hidden
: Match hidden data streams and hidden indices. Must be combined withopen
,closed
, orboth
.none
: Wildcard expressions are not accepted.
- If
false
, the request returns an error if it targets a missing or closed index. - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
- The number of shard copies that must be active before proceeding with the operation. Set to
all
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).
Responses
- 200 application/json
Hide response attributes Show response attributes object