NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Freeze index API
editFreeze index API
editFreezes an index.
Request
editPOST /<index>/_freeze
Description
editA 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
editThe 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.