Create FTP account
This function creates an FTP account.
Important:
When you disable the FTP role, the system disables this function.
Query parameters
The new FTP account username.
Whether to strip dots (.) from the username.
- 1 — Strip dots.
- 0 — Do not strip dots.
The FTP user's associated domain. This must be a domain that the cPanel account owns.
Note:
This parameter defaults to the cPanel account's primary domain.
The path to the FTP account's root directory, relative to the cPanel account's home directory. If you don't set this, it defaults to a directory with the same name as the FTP account.
The new FTP account password.
Note:
You can use the pass_hash parameter in place of this parameter. However, you cannot use both the pass and pass_hash parameters in the same request.
The account's password hash.
Note:
- You can use this parameter in place of the pass parameter. However, you cannot use both the pass and pass_hash parameters in the same request.
- You can find your server's password hash type in the /etc/sysconfig/authconfig file.
The FTP account's maximum disk usage quota, in megabytes (MB).
Note:
A value of 0 grants the FTP account unlimited disk space.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "add_ftp",
"module": "Ftp",
"result": {
"status": 1
}
}