› › ›

Freeze

Phases allowed: cold.

Freezing an index closes the index and reopens it within the same API call. This means that for a short time no primaries are allocated. The cluster will go red until the primaries are allocated. This limitation might be removed in the future.

Options

None.

Example

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "cold": {
        "actions": {
          "freeze" : { }
        }
      }
    }
  }
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/ilm-freeze.html