OpenSearch/docs/reference/indices/open-close.asciidoc

[[indices-open-close]]
== Open / Close Index API

The open and close index APIs allow to close an index, and later on
opening it. A closed index has almost no overhead on the cluster (except
for maintaining its metadata), and is blocked for read/write operations.
A closed index can be opened which will then go through the normal
recovery process.

The REST endpoint is `/{index}/_close` and `/{index}/_open`. For
example:

[source,js]
--------------------------------------------------
POST /my_index/_close

POST /my_index/_open
--------------------------------------------------
// CONSOLE
// TEST[s/^/PUT my_index\n/]

It is possible to open and close multiple indices. An error will be thrown
if the request explicitly refers to a missing index. This behaviour can be
disabled using the `ignore_unavailable=true` parameter.

All indices can be opened or closed at once using `_all` as the index name
or specifying patterns that identify them all (e.g. `*`).

Identifying indices via wildcards or `_all` can be disabled by setting the
`action.destructive_requires_name` flag in the config file to `true`.
This setting can also be changed via 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 disabled via the cluster settings
API by setting `cluster.indices.close.enable` to `false`. The default is `true`.
Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00			`[[indices-open-close]]`
			`== Open / Close Index API`

			`The open and close index APIs allow to close an index, and later on`
			`opening it. A closed index has almost no overhead on the cluster (except`
			`for maintaining its metadata), and is blocked for read/write operations.`
			`A closed index can be opened which will then go through the normal`
			`recovery process.`

			The REST endpoint is `/{index}/_close` and `/{index}/_open`. For
			`example:`

			`[source,js]`
			`--------------------------------------------------`
Add CONSOLE to a few snippets in reference docs This allows them to be run in Console and adds them to the list of docs that are automatically tested as part of the build. Relates to #18160 2016-09-01 13:05:22 -04:00			`POST /my_index/_close`
Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00
Add CONSOLE to a few snippets in reference docs This allows them to be run in Console and adds them to the list of docs that are automatically tested as part of the build. Relates to #18160 2016-09-01 13:05:22 -04:00			`POST /my_index/_open`
Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00			`--------------------------------------------------`
Add CONSOLE to a few snippets in reference docs This allows them to be run in Console and adds them to the list of docs that are automatically tested as part of the build. Relates to #18160 2016-09-01 13:05:22 -04:00			`// CONSOLE`
			`// TEST[s/^/PUT my_index\n/]`
[DOCS] Added multi-index open/close 2013-09-04 20:26:52 +02:00
			`It is possible to open and close multiple indices. An error will be thrown`
			`if the request explicitly refers to a missing index. This behaviour can be`
Replaced `ignore_indices` with `ignore_unavailable`, `expand_wildcards` and `allow_no_indices`. * `ignore_unavailable` - Controls whether to ignore if any specified indices are unavailable, this includes indices that don't exist or closed indices. Either `true` or `false` can be specified. * `allow_no_indices` - Controls whether to fail if a wildcard indices expressions results into no concrete indices. Either `true` or `false` can be specified. For example if the wildcard expression `foo` is specified and no indices are available that start with `foo` then depending on this setting the request will fail. This setting is also applicable when `_all`, `` or no index has been specified. * `expand_wildcards` - Controls to what kind of concrete indices wildcard indices expression expand to. If `open` is specified then the wildcard expression if expanded to only open indices and if `closed` is specified then the wildcard expression if expanded only to closed indices. Also both values (`open,closed`) can be specified to expand to all indices. Closes to #4436 2013-12-12 00:30:12 +01:00			disabled using the `ignore_unavailable=true` parameter.
[DOCS] Added multi-index open/close 2013-09-04 20:26:52 +02:00
			All indices can be opened or closed at once using `_all` as the index name
			or specifying patterns that identify them all (e.g. `*`).

Added `action.destructive_requires_name` that controls whether wildcard expressions and `_all` is allowed to be used for destructive operat Also the delete index api requires always an index to be specified (either concrete index, alias or wildcard expression) Closes #4549 #4481 2014-01-04 18:54:17 +01:00			Identifying indices via wildcards or `_all` can be disabled by setting the
			`action.destructive_requires_name` flag in the config file to `true`.
Add option to disable closing indices Closed indices are currently out of scope for snapshots and shard migration, and can cause issues in managed environments – where closing an index does not necessarily make sense, as it still consumes the managed environment's storage quota. This commit adds an option to dynamically disable closing indices via node or cluster settings. Closes #14168 2015-10-16 22:10:51 +02:00			`This setting can also be changed via the cluster update settings api.`

corrected the use of two synonymous words (#19498) Two synonyms were jointly used in the sentence(i.e "problems" and "issues"), so I deleted one of them. 2016-07-21 11:20:23 +01:00			`Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be disabled via the cluster settings`
			API by setting `cluster.indices.close.enable` to `false`. The default is `true`.