Managing Backups

Operator: <backup-manager>

XML Schema: backup.xsd

Plesk version: 9.0

XML API version:

Plesk user: Administrator, customer


Backup is a file containing a copy of data that is used to restore the original. In Plesk XML API, you can manage backups of Plesk accounts or of the entire Plesk server by the backup-manager operator. One backup may be divided into two or more files. You can use Plesk's storage (local storage) or remote FTP servers to store backup files. Protocols other than FTP are not supported in the current realization.

Backups are divided into four groups:

  • Webspace-level backup. It includes the following:
    • Webspace-related content
    • Webspace configuration (limits and permissions on resources, webspace users, etc.)
  • Customer-level backup. It includes the following:
    • Webspace-level backups of all webspaces owned by a customer
    • Customer-level configuration which includes configuration of the customer account its subordinate webspace accounts
  • Reseller-level backup. It includes the following:
    • Customer-level backups of all customers owned by a reseller
    • Reseller-level configuration which includes configuration of the reseller account and customer-level configurations of all its subordinate customer accounts
  • Server-level backup. It includes content of all webspaces on the server and server-level configuration - configuration of Plesk server and all user accounts.

To back up Plesk data, you need to create a backup task with appropriate arguments defining what will be included into backup. If a backup task is successfully completed, the corresponding backup is created. You can monitor the status of backup tasks or cancel them.


Supported operations


Next in this section:

Retrieving Server-wide Backup Settings

Configuring Server-wide Backup Settings

Remote Storage Settings

Retrieving Remote Storage Settings

Changing Remote Storage Settings

Creating Domain-level Backup Task

Creating Customer-level Backup Task

Creating Reseller-level Backup Task

Creating Server-level Backup Task

Retrieving Backup Task Status

Retrieving a List of Local Backups

Importing Backup to Storage

Downloading Backup

Retrieving Protocols Supported by Backup Manager

Cancelling Backup Tasks

Removing Backup