unfreeze.asciidoc 1.5 KB

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