Restoring an Index backup

Use the list operation to choose a snapshot, checking its repository and included indices before restoring. The example explicitly restores the knowledge index from the snapshot created here.

If snapshotName is omitted, Search selects the latest snapshot in the selected repository. If indexName is omitted, the restore targets eligible current indices. Specify both fields when recovering a particular index from a particular backup. The index must exist so Search can obtain its mappings for the restore.

Example Call

curl -X POST https://telicent.core.domain/api/search/backups/restore \
  -H "Content-Type: application/json" \
  -H "Authorization: ${TC_OIDC_TOKEN}" \
  -d '{"indexName":"knowledge","repositoryName":"scs-snapshots-repo","snapshotName":"backup_snapshot_1751030282819"}'

Response

The response is very simple - just indicating the success of the operation.

{
    "restored": true,
    "message": "Index(s) '[knowledge]' successfully restored from snapshot 'backup_snapshot_1751030282819'."
}

For background execution and polling, see asynchronous jobs.