Request Packet Structure

A request XML packet creating FTP account on a domain includes the add operation node:

<packet version="1.4.2.0">

<ftp-user>

   <add>

   ¡­

   </add>

</ftp-user>

</packet>

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

• The name node is required. It specifies the name under which the FTP account will be known in Plesk, and the account login. Data type: string.
• The password node is required. It specifies the FTP account password. Data type: string.
• The home node is required. It specifies the home directory of the account, i.e., the directory access to which is granted for the account user. Data type: string.
• The create-non-existent node is optional. It specifies if the home directory should be created or not. This node with value true is required if the home directory defined by the home node does not exist on the domain. Data type: boolean.
• The quota node is optional. It specifies the maximum total size of files and folders (in bytes) that the FTP account user can create in or upload to the home directory. Data type: integer.
• The permissions node is optional. It specifies the FTP account permissions for home directory. For more information, refer to section FTP Account Permissions. Data type: FtpUserPermissions.
• The domain-id node is required. It specifies the ID of the domain on which the FTP account is created. Data type: integer.
• The domain-name node is required. It specifies the name of the domain (in unicode) on which the FTP account is created. Data type: string.

Remarks

1. FTP account name must be unique in Plesk, meaning that two FTP accounts with the same name cannot be crated, even if you want to crate them on different domains.

2. The default home directory for any new additional FTP account is the domain root directory (namely, "/"). If you want FTP account created with request packet to have a default home directory, include an empty home node to your request:

 <home/>

If you want to specify account home directory other than default, in the home node specify a full path to desired directory, starting with root domain directory. For example:

<home>/httpdocs/billy/pub</home>

3. Creating new folders in domain root directory is prohibited by Plesk. Therefore, it is impossible to make some /Global_Upload folder a home directory for an account. Do not include to your packets lines like

<home>/Global_Upload</home>

<create-non-existent>true</create-non-existent>

4. To create FTP account with unlimited quota, specify value "-1" in the quota node:

<quota>-1</quota>

5. With one add operation, you can create only one FTP account on a domain specified either by name or by ID.

6. With one packet, you can create as many different FTP accounts on different domains as you want. To create multiple FTP accounts, use the required number of add nodes in the packet.