unfreeze.asciidoc 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. [role="xpack"]
  2. [[unfreeze-index-api]]
  3. === Unfreeze index API
  4. ++++
  5. <titleabbrev>Unfreeze index</titleabbrev>
  6. ++++
  7. [WARNING]
  8. .Deprecated in 7.14
  9. ====
  10. In 8.0, we removed the ability to freeze an index. In previous versions,
  11. freezing an index reduced its memory overhead. However, frozen indices are no
  12. longer useful due to
  13. https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[recent
  14. improvements in heap memory usage].
  15. You can use this API to unfreeze indices that were frozen in 7.x. Frozen indices
  16. are not related to the frozen data tier.
  17. ====
  18. Unfreezes an index.
  19. [[unfreeze-index-api-request]]
  20. ==== {api-request-title}
  21. `POST /<index>/_unfreeze`
  22. [[unfreeze-index-api-prereqs]]
  23. ==== {api-prereq-title}
  24. * If the {es} {security-features} are enabled, you must have the `manage`
  25. <<privileges-list-indices,index privilege>> for the target index or index alias.
  26. [[unfreeze-index-api-desc]]
  27. ==== {api-description-title}
  28. When a frozen index is unfrozen, the index goes through the normal recovery
  29. process and becomes writeable again.
  30. [[unfreeze-index-api-path-parms]]
  31. ==== {api-path-parms-title}
  32. `<index>`::
  33. (Required, string) Identifier for the index.
  34. [[unfreeze-index-api-examples]]
  35. ==== {api-examples-title}
  36. The following example unfreezes an index:
  37. [source,console]
  38. --------------------------------------------------
  39. POST /my-index-000001/_unfreeze
  40. --------------------------------------------------
  41. // TEST[s/^/PUT my-index-000001\n/]
  42. // TEST[skip:unable to ignore deprecation warning]