We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Page tree
Skip to end of metadata
Go to start of metadata



To use this feature, you must enable account backups and the Retain Backups in the Default Backup Directory setting in WHM's Backup Configuration interface (WHM >> Home >> Backup >> Backup Configuration).

If you have disabled the Retain Backups in the Default Backup Directory setting, you can restore a remote backup through the Restore a Full Backup cpmove File interface (WHM >> Home >> Backup >> Restore a Full Backup/cpmove File).

WHM's Backup Configuration interface (WHM >> Home >> Backup >> Backup Configuration) allows you and your users to store backup files in locations that you configured with the Additional Destinations options. This includes the following destinations:

  • Amazon S3™
  • FTP
  • Google Drive™
  • S3 Compatible
  • SFTP
  • WebDAV
  • A local directory
  • Custom locations

To restore backups from these locations, users must transfer the backup file to their servers before they can restore the backups.

How to transfer the backup file


You must manually transfer the backup files from the remote location to your server. However, after you transfer the backup files to the server, WHM's Backup Restoration feature handles the actual restoration.


To transfer a backup file from a remote location to your server, perform the following steps:

  1. Use your preferred tool to access the additional destination that you created with the Additional Destinations options in WHM's Backup Configuration interface (WHM >> Home >> Backup >> Backup Configuration). For example, you can use an FTP client to access an FTP destination.
  2. Locate your desired backup files and transfer them to your local computer.
  3. Place the backup files in the appropriate backup directory on your server.


    The backup directories on your server will resemble the BACKUPDIR/yyyy-mm-dd/accounts format, where:

    • BACKUPDIR is the variable from the /var/cpanel/backups/config file.
    • yyyy is the four-digit year, mm is the month, and dd is the day of the month.

    For example, on a server that stores backups in the /home/backup directory, the weekly backup on December 16, 2018 for the example user will exist in the /home/backup/weekly/2018-12-16/accounts/example.tar.gz file.

WHM's Backup Restoration interface (WHM >> Home >> Backup >> Backup Restoration) will now display the backup files under the appropriate account and date.

Additional documentation

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels