IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Explore API Index lifecycle management API »

› ›

Freeze index API

edit

Freeze index API

edit

Freezes an index.

Request

edit

POST /<index>/_freeze

Description

edit

A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory), and is blocked for write operations. See Frozen indices and Unfreeze index.

Path Parameters

edit

index (required): (string) Identifier for the index

Examples

edit

The following example freezes and unfreezes an index:

POST /my_index/_freeze
POST /my_index/_unfreeze

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.

« Explore API Index lifecycle management API »