Elasticsearch OpenSearch Restore

By Opster Team

Updated: Jun 27, 2023

| 1 min read

Quick links

Overview

What is OpenSearch restore and what is it used for?

In OpenSearch, restore refers to the snapshot restore mechanism, which returns indices or clusters to a previous, saved state. You can restore the entire cluster from the snapshot or restore an individual index or selected indices.

Examples

To restore the whole snapshot:

POST /_snapshot/my_backup/snapshot-01-11-2019/_restore

To restore an individual index:

POST /_snapshot/my_backup/snapshot-01-11-2019/_restore
{
  "indices": "my_index"
}

Notes

  • If you are using a security tool like Searchguard, the snapshot restore capability must be enabled in opensearch.yml. Otherwise, it will throw a security exception.

Common issues

  • If an index or indices already exist with the same names as those you are going to restore, they need to either be closed or deleted before you can restore from a snapshot. Otherwise, the restore operation will fail due to an error that the index already exists.

How helpful was this guide?

We are sorry that this post was not useful for you!

Let us improve this post!

Tell us how we can improve this post?