GET

List Backups


Developer Preview

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

Retrieves a list of all backups for a site.

Results are sorted by requested date, with the newest first.

You can use this method to check whether a backup initiated with Create Backup has been completed successfully.

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
GET
https://www.wixapis.com/wix-data/v2/backups

Query Params
statusArray <string>

Statuses to filter by. If provided, only backups with the specified statuses are listed. For example, to list only completed backups, use ?status=READY. To list completed and pending backups, use ?status=READY&status=PENDING.

Default: No filtering


typeArray <string>

Type to filter by. If provided, only backups of the specified type are listed.

Default: No filtering


paging.limitintegerminimum 0format int32

Number of items to load.


paging.offsetintegerminimum 0format int32

Number of items to skip in the current sort order.

Response Object
backupsArray <Backup>maxItems 1000

Retrieved backups.


pagingMetadataPagingMetadata

Paging information.

Request
cURL
curl -X GET \ 'https://www.wixapis.com/wix-data/v2/backups' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "backups": [ { "id": "8c683199-dbd9-4591-883f-32b0298ecaf2", "requestedDate": "2022-05-25T15:12:06.797Z", "startedDate": "2022-05-25T15:12:07.025Z", "finishedDate": null, "deletedDate": null, "sizeInBytes": null, "status": "PENDING", "type": "ON_DEMAND" }, { "id": "11384bcd-2106-416d-8ec6-19fbb7d92c20", "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" } ], "paging_metadata": { "count": 2, "offset": 0 } }
Errors

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

Did this help?