POST

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

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

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
Request
This endpoint does not take any parameters.
Response Object
backupBackup

Details of the requested backup.

Create a backup
Request
cURL
curl -X POST \
'https://www.wixapis.com/wix-data/v2/backups' \
-H "Accept: application/json" \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
Response
JSON
{
  "backup": {
    "id": "8af59df8-4915-45d1-b4d3-a31592d9311c",
    "requestedDate": "2022-07-27T13:14:59.903407Z",
    "startedDate": null,
    "finishedDate": null,
    "deletedDate": null,
    "sizeInBytes": null,
    "status": "PENDING",
    "type": "ON_DEMAND"
  }
}
Errors

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

Did this help?