unfreeze.asciidoc 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[unfreeze-index-api]]
  4. === Unfreeze index API
  5. ++++
  6. <titleabbrev>Unfreeze index</titleabbrev>
  7. ++++
  8. Unfreezes an index.
  9. [[unfreeze-index-api-request]]
  10. ==== {api-request-title}
  11. `POST /<index>/_unfreeze`
  12. [[unfreeze-index-api-prereqs]]
  13. ==== {api-prereq-title}
  14. * If the {es} {security-features} are enabled, you must have the `manage`
  15. <<privileges-list-indices,index privilege>> for the target index or index alias.
  16. [[unfreeze-index-api-desc]]
  17. ==== {api-description-title}
  18. When a frozen index is unfrozen, the index goes through the normal recovery
  19. process and becomes writeable again. See <<freeze-index-api>>.
  20. IMPORTANT: Freezing an index will close the index and reopen it within the same
  21. API call. This causes primaries to not be allocated for a short amount of time
  22. and causes the cluster to go red until the primaries are allocated again. This
  23. limitation might be removed in the future.
  24. [[unfreeze-index-api-path-parms]]
  25. ==== {api-path-parms-title}
  26. `<index>`::
  27. (Required, string) Identifier for the index.
  28. [[unfreeze-index-api-examples]]
  29. ==== {api-examples-title}
  30. The following example freezes and unfreezes an index:
  31. [source,console]
  32. --------------------------------------------------
  33. POST /my-index-000001/_freeze
  34. POST /my-index-000001/_unfreeze
  35. --------------------------------------------------
  36. // TEST[s/^/PUT my-index-000001\n/]