Deleting FTP Accounts

Use the del operation to remove FTP accounts from Plesk database. You can use this operation for deleting particular FTP accounts defined by name or ID, for deleting all FTP accounts existing on particular sites, also defined by name or ID, or for deleting all FTP accounts existing on all sites you can manage. In the last case, Plesk Administrator deletes all additional FTP accounts created on the whole Plesk server, Plesk customer, in turn, deletes all additional FTP accounts created on his sites.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet deleting FTP account includes the del operation node:

<packet version="1.4.2.0">
<ftp-user>
   <del>
   ...
   </del>
</ftp-user>
</packet>

 

The del node is presented by the FtpUserDelInputType complex type (ftpuser.xsd). The node has the following graphical representation:

 

Remarks

With one packet, you can delete as many different FTP accounts with different filtering rules as you want. To do so, use the required number of del nodes in the packet.

 

Response Packet Structure

The del node of the output XML packet is structured as follows:

 

 

Samples

Deleting single FTP account

This packet deletes FTP account with name photo4.

<packet>
<ftp-user>
<del>
   <filter>
      <name>photo4</name>
    </filter>
 </del>
</ftp-user>
</packet>

Response:

<packet>
<ftp-user>
<del>
   <result>
      <status>ok</status>
      <filter-id>photo4</filter-id>
      <id>15</id>
   </result>
</del>
</ftp-user>
</packet>
Deleting multiple FTP accounts

This packet deletes FTP accounts with names ftpuser2, photo6.

<packet>
<ftp-user>
<del>
   <filter>
      <name>ftpuser2</name>
      <name>photo6</name>
    </filter>
 </del>
</ftp-user>
</packet>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <ftp-user>
    <del>
      <result>
        <status>error</status>
        <errcode>1013</errcode>
        <errtext>ftp-user does not exist</errtext>
        <filter-id>ftpuser2</filter-id>
      </result>
      <result>
        <status>error</status>
        <errcode>1013</errcode>
        <errtext>ftp-user does not exist</errtext>
        <filter-id>photo6</filter-id>
      </result>
    </del>
  </ftp-user>
</packet>
Deleting all FTO accounts on a site

This packet deletes all FTP accounts existing on site example.com.

<packet>
<ftp-user>
<del>
   <filter>
      <webspace-name>example.com</webspace-name>
    </filter>
 </del>
</ftp-user>
</packet>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <ftp-user>
    <del>
      <result>
        <status>ok</status>
        <filter-id>example.com</filter-id>
        <id>2</id>
      </result>
      <result>
        <status>ok</status>
        <filter-id>example.com</filter-id>
        <id>3</id>
      </result>
      <result>
        <status>ok</status>
        <filter-id>example.com</filter-id>
        <id>4</id>
      </result>
    </del>
  </ftp-user>
</packet>
Deleting all FTP accounts that can be managed by Plesk user

This packet removes all FTP accounts that can be managed by Plesk user defined in HTTP headers of the packet.

<packet>
<ftp-user>
<del>
   <filter/>
</del>
</ftp-user>
</packet>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <ftp-user>
    <del>
      <result>
        <status>ok</status>
        <filter-id>1</filter-id>
        <id>1</id>
      </result>
    </del>
  </ftp-user>
</packet>