elasticsearch/docs/reference/indices/close.asciidoc

[[indices-close]]
=== Close index API
++++
<titleabbrev>Close index</titleabbrev>
++++

Closes an index.

[source,console]
--------------------------------------------------
POST /twitter/_close
--------------------------------------------------
// TEST[setup:twitter]


[[close-index-api-request]]
==== {api-request-title}

`POST /<index>/_close`


[[close-index-api-desc]]
==== {api-description-title}

You use the close index API to close open indices.

include::{docdir}/indices/open-close.asciidoc[tag=closed-index]


[[close-index-api-path-params]]
==== {api-path-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
+
To close all indices, use `_all` or `*`.
To disallow the closing of indices with `_all` or wildcard expressions,
change the `action.destructive_requires_name` cluster setting to `true`.
You can update this setting in the `elasticsearch.yml` file
or using the <<cluster-update-settings,cluster update settings>> API.


[[close-index-api-query-params]]
==== {api-query-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]

include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
Defaults to `open`.

include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]

include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]

include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]


[[close-index-api-example]]
==== {api-examples-title}

The following example shows how to close an index:

[source,console]
--------------------------------------------------
POST /my_index/_close
--------------------------------------------------
// TEST[s/^/PUT my_index\n/]

The API returns following response:

[source,console-result]
--------------------------------------------------
{
    "acknowledged" : true,
    "shards_acknowledged" : true,
    "indices" : {
        "my_index" : {
            "closed" : true
        }
    }
}
--------------------------------------------------