Request Packet Structure

A request XML packet creating a client-level backup task includes the backup-client operation node:

<packet version="1.6.0.0">

<backup-manager>

   <backup-client>

...

   </backup-client>

</backup-manager>

</packet>

The backup-client node is presented by type BackupClientInput (backup.xsd), and its graphical representation is as follows:

• The client-id node is required. It specifies the client ID. Data type: integer.
• The client-login node is required. It specifies the client login. Data type: string.
• The local node is required. It specifies if the backup will be stored in the local repository. Data type: none.
• The remote node is required. It specifies if the backup will be stored in a remote storage. Data type: none.
• The prefix node is optional. It specifies the backup name prefix. Data type: string.
• The description node is required. It specifies the description of the backup. Data type: string.
• The split-size node is optional. The parameter specifies size of fragments (in Kb) into which the backup is partitioned. Data type: integer.
• The only-hosting node is optional. The parameter instructs Plesk to exclude mail accounts content from the domains content added to the backup. Data type: none.
• The only-mail node is optional. The parameter instructs Plesk to add only mail accounts content to the backup. Data type: none.
• The only-configuration node is optional. The parameter instructs Plesk to include only client-level configuration into the backup. Data type: none.

Note: If you do not want to split backup into several files, the split-size value should be set to 0.