Close an index

POST /{index}/_close

A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index. Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.

When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. The shards will then go through the normal recovery process. The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.

You can open and close multiple indices. An error is thrown if the request explicitly refers to a missing index. This behaviour can be turned off using the ignore_unavailable=true parameter.

By default, you must explicitly name the indices you are opening or closing. To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API.

Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false.

Required authorization

Index privileges: manage

Path Parameters

index union IndexName | [] IndexName required: Comma-separated list or wildcard expression of index names used to limit the request.

Query Parameters

allow_no_indices boolean · default: true

A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

expand_wildcards string ExpandWildcards · default: open

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.

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 with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

ignore_unavailable boolean · default: false

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

master_timeout string Duration · default: 30s

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.

timeout string Duration · default: 30s

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

wait_for_active_shards WaitForActiveShards · default: 1

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).

Values: all index-setting

Response

application/json

Examples

A successful response for closing an index.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /my-index-00001/_close

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.close({
  index: "my-index-00001",
});

Python Elasticsearch Python Client

resp = client.indices.close(
    index="my-index-00001",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-00001/_close" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().close(c -> c
    .index("my-index-00001")
);

C# Elasticsearch .NET Client

var response = await client.Indices.CloseAsync(indices: new[] { "my-index-00001" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->close([
    "index" => "my-index-00001",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.close(
  index: "my-index-00001"
)

Response

{
  "acknowledged": true,
  "shards_acknowledged": true,
  "indices": {
    "my-index-000001": {
      "closed": true
    }
  }
}

Required authorization

Path Parameters

Query Parameters { allow_no_indices , expand_wildcards , ignore_unavailable , master_timeout , timeout , wait_for_active_shards , }

Response

Query Parameters