Changing Remote Storage Settings

Use the set-remote-storage-settings operation to change settings of a remote backups FTP storage.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet changing remote storage settings includes the set-remote-storage-settings operation node:

<packet>
<backup-manager>
   <set-remote-storage-settings>
...
   </set-remote-storage-settings>
</backup-manager>
</packet>

 

The set-remote-storage-settings node is presented by type BackupSetRemoteStorageInput (backup.xsd), and its graphical representation is as follows:

Note: If you do not define a target Plesk user, the operation will use packet sender identifier.

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

The set-remote-storage-settings node of the output XML packet is presented by type BackupSetRemoteStorageSettingsOutput (backup.xsd) and structured as follows:

 

 

Samples

Changing remote storage settings for the customer account

This request packet changes remote storage settings for the customer account with ID 17.

<packet version="1.6.3.0">
<backup-manager>
   <set-remote-storage-settings>
      <customer-id>17</customer-id>
<settings>
      <protocol>ftp</protocol>
      <host>ftp.example.com</host>
      <port>112</port>
</settings>
   </set-remote-storage-settings>
</backup-manager>
</packet>

 Response:

<packet version="1.6.3.0">
<backup-manager>
   <set-remote-storage-settings>
      <result>
            <status>ok</status>
      </result>
   </set-remote-storage-settings>
</backup-manager>
</packet>

 

If the customer account was not found on the server, the response looks as follows:

<packet version="1.6.3.0">
  <backup-manager>
    <set-remote-storage-settings>
      <result>
        <status>error</status>
        <errcode>1013</errcode>
        <errtext>client does not exist</errtext>
      </result>
    </set-remote-storage-settings>
  </backup-manager>
</packet>