unfreeze.asciidoc 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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. [[unfreeze-index-api-desc]]
  15. ==== {api-description-title}
  16. When a frozen index is unfrozen, the index goes through the normal recovery
  17. process and becomes writeable again. See <<frozen-indices>> and <<freeze-index-api>>.
  18. IMPORTANT: Freezing an index will close the index and reopen it within the same
  19. API call. This causes primaries to not be allocated for a short amount of time
  20. and causes the cluster to go red until the primaries are allocated again. This
  21. limitation might be removed in the future.
  22. [[unfreeze-index-api-path-parms]]
  23. ==== {api-path-parms-title}
  24. `<index>`::
  25. (Required, string) Identifier for the index.
  26. [[unfreeze-index-api-examples]]
  27. ==== {api-examples-title}
  28. The following example freezes and unfreezes an index:
  29. [source,console]
  30. --------------------------------------------------
  31. POST /my_index/_freeze
  32. POST /my_index/_unfreeze
  33. --------------------------------------------------
  34. // TEST[s/^/PUT my_index\n/]