POST

Restore Backup

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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Data Backups
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/wix-data/v2/backups/{backupId}/restore
Path Params
backupIdstringRequired

ID of backup to be restored.

Response Object
restorationRestoration

Details of data restoration from backup.

Restore data from a backup
Request
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: <AUTH>'
Response
JSON
{
  "restoration": {
    "id": "0bd30197-2012-4c35-a4f0-a0d5ef7ecea0",
    "requestedDate": "2022-05-26T07:17:02.209Z",
    "startedDate": null,
    "finishedDate": null,
    "backup": {
      "id": "bfab4dac-c835-4cf7-8b47-adbe1ca1ea34",
      "requestedDate": "2022-05-25T15:10:56.394Z",
      "startedDate": "2022-05-25T15:10:56.603Z",
      "finishedDate": "2022-05-25T15:10:56.913Z",
      "deletedDate": null,
      "sizeInBytes": "1584",
      "status": "READY",
      "type": "ON_DEMAND"
    },
    "status": "PENDING"
  }
}
Errors

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

Did this help?