createBackup( )


Creates an on-demand backup of live content in a site's collections.

By default, all of the site's collections are included in the backup. For a partial backup, specify which collections to include in the backup.collections parameter.

The process of creating a backup takes time. You can check whether a backup has completed successfully with List Backups.

You can store up to 3 on-demand backups for each site. If 3 on-demand backups already exist, the oldest existing on-demand backup for the site is deleted when a new one is created. Automated backups are not affected.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Data Backups
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<CreateBackupResponse>
Errors

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

Did this help?