Freeze index APIedit

Freezes an index.

Requestedit

POST /<index>/_freeze

Descriptionedit

A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only. Read-only indices are blocked for write operations, such as docs-index_ or force merges. See Frozen indices and Unfreeze index.

The current write index on a data stream cannot be frozen. In order to freeze the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be frozen.

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.

Path parametersedit

<index>
(Required, string) Identifier for the index.

Examplesedit

The following example freezes and unfreezes an index:

POST /my_index/_freeze
POST /my_index/_unfreeze