Managing Plesk Backups

Operator: <backup-manager>

XML Schema: backup.xsd

Plesk version: 8.2

API RPC version: 1.5.1.0

Plesk user: Plesk Administrator, Plesk client

Description

Backup is a copy of data that may be used to restore the original after a data loss. In Plesk API RPC, you can manage backups of client and domain accounts by the backup-manager operator. Backups are created in asynchronous mode. One backup may be divided into two or more files. You can use Plesk repository (local storage) or remote FTP servers to store backup files. Protocols other than FTP are not supported in current realization.

Process that creates backups is called backup process.

Supported operations

• GET-REMOTE-STORAGE-SETTINGS retrieves settings of a remote FTP storage
• SET-REMOTE-STORAGE-SETTINGS changes settings of a remote FTP storage
• BACKUP-DOMAIN creates a backup of a specified domain account
• BACKUP-CLIENT creates a backup of one or more domain accounts held by a specified client
• GET-BACKUP-STATUS retrieves the status of the backup process for a specified domain or client account
• GET-LOCAL-BACKUP-LIST retrieves a list of backups stored in the local repository
• PUT-FILE moves backups from a temporary directory on Plesk server to the client's or domain administrator's repository
• DOWNLOAD-FILE downloads a backup from the server
• GET-SUPPORTED-PROTOCOL retrieves protocols supported by the backup-manager operator
• STOP-BACKUP stops the backup process for a specified domain or client accounts
• GET-BACKUP-PROCESSES retrieves a list of backup processes
• REMOVE-FILE removes a specified backup from a repository