restorePartialBackup( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Restores specific collections 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.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Data Backups
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
backupIdstringRequired

ID of backup to be restored.

restorationCollectionsArray<RestorationCollection>Required

Required. 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.

Returns
Return Type:Promise<RestorePartialBackupResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?