Backup & Restore

Official guide · English · Version 9c253d0cf11816df

The Backup & Restore tab lets you export supported central account data, download backup archives, restore from a previously created backup, and view backup and restore history. It is not a VPS disk image or an email backup.

Overview

The page is divided into three cards:

Card Description
Create Backup Start a new full data export. The backup is packaged as a ZIP file and automatically downloaded.
Restore from Backup Upload a previously downloaded backup ZIP file to restore your data.
Backup History View a table of all past backup and restore operations with their status, size, and download links.

Create Backup

Creating a backup exports all of your account data into a ZIP archive. The backup runs on the server and you can watch its progress in real time.

What Is Included in a Backup

A central account backup includes supported account records such as:

  • Products, categories, and media references
  • Conversations and messages
  • Orders and transactions
  • Customer data
  • Settings and configurations
  • Team members
  • Integrations

Passwords, login sessions, subscription/payment-provider billing records and platform administrator settings are not an account recovery export. Integration records can contain private credentials: keep the archive secure and verify connections after restoration. This workflow exports media references and does not guarantee an independent copy of every remotely hosted file. For catalog image files, use Products > Export Backup. Back up the VPS website and mailbox messages through their separate tools.

How to Create a Backup

  1. Navigate to Settings > Backup & Restore.
  2. In the Create Backup card, click the Create Backup button.
  3. A progress bar will appear showing the current step and percentage completion.
  4. Wait for the backup to reach 100%. The progress is updated every 3 seconds.
  5. Once completed, the backup ZIP file will be automatically downloaded to your browser.
  6. A green success message will confirm the backup was created successfully.

Backup States

State Description
Pending The backup has been queued and will start shortly.
Exporting Data is being collected and packaged. A progress bar shows the current step and percentage.
Completed The backup is ready. The ZIP file is automatically downloaded.
Failed The backup encountered an error. An error message will be displayed with details.

Info: If the automatic download fails after a successful backup (e.g., due to a popup blocker), you can manually download the backup from the Backup History table at the bottom of the page.


Restore from Backup

The Restore feature lets you upload a previously downloaded backup ZIP file to replace your current data.

Warning: Restoring from a backup will overwrite your current data with the contents of the backup file. This action cannot be undone. Make sure you have a current backup of your existing data before proceeding.

How to Restore from a Backup

  1. Navigate to Settings > Backup & Restore.
  2. In the Restore from Backup card, click the file input and select a .zip backup file from your computer.
  3. Click the Restore button.
  4. A confirmation dialog will appear with a warning that restoring will overwrite your current data.
  5. Click Yes, Restore to confirm, or Cancel to abort.
  6. If confirmed, a progress bar will appear showing the restore progress (updated every 3 seconds).
  7. Once the restore is complete, a success message will confirm the operation.

Restore States

State Description
Importing Data from the backup file is being applied. A progress bar shows the current step and percentage (displayed with an orange progress indicator).
Completed The restore is finished. All data from the backup has been applied.
Failed The restore encountered an error. An error message will be displayed. Your data may be in a partially restored state.

Accepted File Format

  • Only .zip files are accepted.
  • The file must be a backup previously created by the DirectSale platform.
  • Uploading an invalid or corrupted file will result in an error.

Backup History

The Backup History card displays a table of all backup and restore operations for your account, with the 20 most recent entries shown.

Table Columns

Column Description
Date The date and time when the backup or restore operation was initiated.
Type Either Export (backup creation) or Import (restore from backup). Exports are shown with a blue badge, imports with an orange badge.
Status The current state of the operation. Color-coded: green for completed, red for failed, yellow for pending/in-progress.
Size The file size of the backup archive (displayed in human-readable format: B, KB, MB, or GB). Shows a dash if size is not available.
Actions Available actions for each entry.

Available Actions per Entry

Action Icon Availability Description
Download Download arrow Completed exports only Download the backup ZIP file to your computer.
Delete Trash All entries Remove the backup record and its associated file from the server.

How to Download a Previous Backup

  1. In the Backup History table, find the backup you want to download.
  2. Make sure the Type is "Export" and the Status is "Completed."
  3. Click the Download button (download arrow icon) in the Actions column.
  4. The ZIP file will be downloaded to your browser.

How to Delete a Backup Record

  1. In the Backup History table, find the entry you want to remove.
  2. Click the Delete button (trash icon) in the Actions column.
  3. The record will be removed from the list and the associated file (if any) will be deleted from the server.

Info: Deleting a backup record from the history does not affect your current account data. It only removes the backup file from the server. If you have already downloaded the backup to your computer, that local copy is unaffected.


Best Practices

  1. Create regular backups -- Before making major changes to your product catalog, settings, or integrations, create a backup so you can roll back if needed.
  2. Download and store backups locally -- Do not rely solely on server-stored backups. Download the ZIP file and save it in a secure location.
  3. Test restores carefully -- Before restoring, make sure you understand that it will overwrite your current data. Always create a fresh backup of your current state first.
  4. Monitor backup sizes -- As your account grows, backup files will increase in size. Review your backup history periodically and delete old entries you no longer need.