OpenSearch/docs/reference/indices/apis/unfreeze.asciidoc

51 lines
1.1 KiB
Plaintext

[role="xpack"]
[testenv="basic"]
[[unfreeze-index-api]]
== Unfreeze index API
++++
<titleabbrev>Unfreeze index</titleabbrev>
++++
Unfreezes an index.
[float]
=== Request
`POST /<index>/_unfreeze`
[float]
=== Description
When a frozen index is unfrozen, the index goes through the normal recovery
process and becomes writeable again. See <<frozen-indices>> and <<freeze-index-api>>.
[float]
=== Path Parameters
`index` (required)::
(string) Identifier for the index
//=== Query Parameters
//=== Authorization
[float]
=== Examples
The following example freezes and unfreezes an index:
[source,js]
--------------------------------------------------
POST /my_index/_freeze
POST /my_index/_unfreeze
--------------------------------------------------
// CONSOLE
// TEST[s/^/PUT my_index\n/]
[IMPORTANT]
================================
Freezing an index will close the index and reopen it within the same API call. This causes primaries to not be allocated for a short
amount of time and causes the cluster to go red until the primaries are allocated again. This limitation might be removed in the future.
================================