Retrieving Server-wide Backup Settings

The get-server-wide-settings operation is used to retrieve the server-wide backup settings.

Request Packet

A request XML packet retrieving backup settings includes the get-server-wide-settings operation node:

<packet>
  <backup-manager>
    <get-server-wide-settings/>
  </backup-manager>
</packet> 

The get-server-wide-settings node is required. Data type: NoneType.

Response Packet Structure

The get-server-wide-settings node of the response XML packet is presented by type BackupGetServerWideSettingsOutput (backup.xsd) and structured as follows:

The result node wraps the response retrieved from the server. Data type: resultFilterType (common.xsd).

• result, required. It wraps the response got from the server. Data type: resultFilterType (common.xsd).
• status, required. It specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
• errcode, optional. It returns the error code when the operation fails. Data type: unsignedInt.
• errtext, optional. It returns the error message if the operation fails. Data type: string.

The information about the backup settings is held by the settings node, which is presented by the complex type BackupServerWideSettings (backup.xsd). The node is structured as follows:

• The max-backup-files node is optional. It holds the maximum number of scheduled backups that can be stored in any type of storage. The value -1 means unlimited. Data type: integer.
• The max-backup-processes node is optional. It holds the maximum number of simultaneously running scheduled backup processes. Data type: integer.
• The low-priority node is optional. It indicates whether to run scheduled backup processes with low priority. Data type: boolean.
• The do-not-compress node is optional. It indicates whether to disable or enable the compression of scheduled backup files. Data type: boolean.
• The allow-local-ftp-backup node is optional. It indicates whether to allow the use of Plesk server as an FTP storage for Plesk backups. Data type: boolean.
• The keep-local-backup node is optional. It indicates whether to save backups in the Plesk server storage if their upload to FTP storage fails. Data type: boolean.

Response Sample

A positive response packet received from the server can look as follows:

<packet version="1.6.7.0">
  <backup-manager>
    <get-server-wide-settings>
      <result>
        <status>ok</status>
        <settings>
          <max-backup-files>12</max-backup-files>
          <max-backup-processes>10</max-backup-processes>
          <low-priority>false</low-priority>
          <do-not-compress>false</do-not-compress>
          <allow-local-ftp-backup>false</allow-local-ftp-backup>
          <keep-local-backup>true</keep-local-backup>
        </settings>
      </result>
    </get-server-wide-settings>
  </backup-manager>
</packet>