unfreeze.asciidoc 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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. [float]
  10. === Request
  11. `POST /<index>/_unfreeze`
  12. [float]
  13. === Description
  14. When a frozen index is unfrozen, the index goes through the normal recovery
  15. process and becomes writeable again. See <<frozen-indices>> and <<freeze-index-api>>.
  16. [float]
  17. === Path Parameters
  18. `index` (required)::
  19. (string) Identifier for the index
  20. //=== Query Parameters
  21. //=== Authorization
  22. [float]
  23. === Examples
  24. The following example freezes and unfreezes an index:
  25. [source,js]
  26. --------------------------------------------------
  27. POST /my_index/_freeze
  28. POST /my_index/_unfreeze
  29. --------------------------------------------------
  30. // CONSOLE
  31. // TEST[s/^/PUT my_index\n/]
  32. [IMPORTANT]
  33. ================================
  34. Freezing an index will close the index and reopen it within the same API call. This causes primaries to not be allocated for a short
  35. amount of time and causes the cluster to go red until the primaries are allocated again. This limitation might be removed in the future.
  36. ================================