> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # RestoreBackup # Package: operations # Namespace: BackupService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/cms/operations/backups/restore-backup.md ## Permission Scopes: Manage Data Backups: SCOPE.DC-DATA.MANAGE-BACKUPS ## Introduction Restores all data from a backup. The process of restoring data from a backup takes time. You can check whether your restoration has completed successfully with List Restorations. --- ## REST API ### Schema ``` Method: restoreBackup Description: Restores all data from a backup. The process of restoring data from a backup takes time. You can check whether your restoration has completed successfully with List Restorations. URL: https://www.wixapis.com/wix-data/v2/backups/{backupId}/restore Method: POST Return type: RestoreBackupResponse - name: restoration | type: Restoration | description: Details of data restoration from backup. - name: id | type: string | description: Restoration GUID. - name: backup | type: Backup | description: Details of the backup used for the restoration. - name: id | type: string | description: Backup GUID. - name: status | type: Status | description: Backup status. - enum: - PENDING: Backup creation is in progress. - READY: Backup has been created successfully and can be used for data restoration. - FAILED: Backup creation has failed. - DELETED: Backup has been deleted. - CANCELED: Backup has been canceled. - name: type | type: Type | description: Type of backup, based on how it was triggered. - enum: - ON_DEMAND: Backup taken on demand. - AUTO: Backup taken automatically by the system on a regular schedule. - name: requestedDate | type: string | description: Date and time the backup was requested. - name: startedDate | type: string | description: Date and time the backup commenced. Value is `null` until the backup process begins in the background. - name: finishedDate | type: string | description: Date and time the backup process finished. Value is `null` until the backup process is completed in the background. - name: deletedDate | type: string | description: Date and time the backup was deleted. Value is `null` if that backup hasn't been deleted. - name: sizeInBytes | type: string | description: Backup size in bytes. Value is `null` until the backup process is completed. - name: collections | type: array | description: IDs and display names of collections the backup contains. - name: id | type: string | description: Collection GUID. - name: displayName | type: string | description: Collection display name. - name: status | type: Status | description: Status of restoration. - enum: - PENDING: Restoration from a backup is in progress. - COMPLETED: Restoration from a backup has been successful. - FAILED: Restoration from a backup has failed. - name: requestedDate | type: string | description: Date and time the restoration was requested. - name: startedDate | type: string | description: Date and time the restoration commenced. Value is `null` until the restoration process begins in the background. - name: finishedDate | type: string | description: Date and time the restoration finished. Value is `null` until the restoration process is completed in the background. - name: restorationCollections | type: array | description: Restored collections. - name: dataCollectionId | type: string | description: Collections to be restored. Note: If collections have a multi-reference relationship, the preexisting references will be restored if at least one of those collections are restored. - name: restoreDestination | type: RestoreDestination | description: Destination where to restore the collection. When not specified destination is taken from backup. - name: dataCollectionId | type: string | description: Collection GUID. - name: displayName | type: string | description: Collection's display name as shown in the CMS. If empty, `displayName` is taken from `backup.collections`. ``` ### Examples ### Restore data from a backup ```curl curl -X POST \ 'https://www.wixapis.com/wix-data/v2/backups/restore/bfab4dac-c835-4cf7-8b47-adbe1ca1ea34' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.operations.BackupService.restoreBackup(backupId) Description: Restores all data from a backup. The process of restoring data from a backup takes time. You can check whether your restoration has completed successfully with List Restorations. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: backupId Method parameters: param name: backupId | type: string | description: GUID of backup to be restored. | required: true Return type: PROMISE - name: restoration | type: Restoration | description: Details of data restoration from backup. - name: _id | type: string | description: Restoration GUID. - name: backup | type: Backup | description: Details of the backup used for the restoration. - name: _id | type: string | description: Backup GUID. - name: status | type: Status | description: Backup status. - enum: - PENDING: Backup creation is in progress. - READY: Backup has been created successfully and can be used for data restoration. - FAILED: Backup creation has failed. - DELETED: Backup has been deleted. - CANCELED: Backup has been canceled. - name: type | type: Type | description: Type of backup, based on how it was triggered. - enum: - ON_DEMAND: Backup taken on demand. - AUTO: Backup taken automatically by the system on a regular schedule. - name: requestedDate | type: Date | description: Date and time the backup was requested. - name: startedDate | type: Date | description: Date and time the backup commenced. Value is `null` until the backup process begins in the background. - name: finishedDate | type: Date | description: Date and time the backup process finished. Value is `null` until the backup process is completed in the background. - name: deletedDate | type: Date | description: Date and time the backup was deleted. Value is `null` if that backup hasn't been deleted. - name: sizeInBytes | type: string | description: Backup size in bytes. Value is `null` until the backup process is completed. - name: collections | type: array | description: IDs and display names of collections the backup contains. - name: _id | type: string | description: Collection GUID. - name: displayName | type: string | description: Collection display name. - name: status | type: Status | description: Status of restoration. - enum: - PENDING: Restoration from a backup is in progress. - COMPLETED: Restoration from a backup has been successful. - FAILED: Restoration from a backup has failed. - name: requestedDate | type: Date | description: Date and time the restoration was requested. - name: startedDate | type: Date | description: Date and time the restoration commenced. Value is `null` until the restoration process begins in the background. - name: finishedDate | type: Date | description: Date and time the restoration finished. Value is `null` until the restoration process is completed in the background. - name: restorationCollections | type: array | description: Restored collections. - name: dataCollectionId | type: string | description: Collections to be restored. Note: If collections have a multi-reference relationship, the preexisting references will be restored if at least one of those collections are restored. - name: restoreDestination | type: RestoreDestination | description: Destination where to restore the collection. When not specified destination is taken from backup. - name: dataCollectionId | type: string | description: Collection GUID. - name: displayName | type: string | description: Collection's display name as shown in the CMS. If empty, `displayName` is taken from `backup.collections`. ``` ### Examples ### restoreBackup ```javascript import { backups } from '@wix/data'; async function restoreBackup(backupId) { const response = await backups.restoreBackup(backupId); }; ``` ### restoreBackup (with elevated permissions) ```javascript import { backups } from '@wix/data'; import { auth } from '@wix/essentials'; async function myRestoreBackupMethod(backupId) { const elevatedRestoreBackup = auth.elevate(backups.restoreBackup); const response = await elevatedRestoreBackup(backupId); } ``` ### restoreBackup (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { backups } from '@wix/data'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { backups }, // Include the auth strategy and host as relevant }); async function restoreBackup(backupId) { const response = await myWixClient.backups.restoreBackup(backupId); }; ``` ---