Create FTP account

This function creates an FTP account.

Important:

When you disable the FTP role, the system disables this function.

Authorizations:
query Parameters
user
required
string

The new FTP account username.

Example: user=username
disallowdot
integer
Default: 1

Whether to strip dots (.) from the username.

  • 1 — Strip dots.
  • 0 — Do not strip dots.
Enum: 0 1
Example: disallowdot=1
domain
string <domain>

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.

Example: domain=example.com
homedir
string <path>

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.

Example: homedir=exampleftp
pass
string

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.

Example: pass=123456luggage
pass_hash
string
Default: ""

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.
Example: pass_hash=$6$1sOyHP5ZDYp3pGUz$R0TSgfPRHfDjT5PP5RJGv39FhiGTNNPvM7IFpCBjXijMmlMZk9yI8T3LqGuntc9fdKb5eX.lGL7wBS9e4DAWn/
quota
integer >= 0
Default: 0

The FTP account's maximum disk usage quota, in megabytes (MB).

Note:

A value of 0 grants the FTP account unlimited disk space.

Example: quota=42

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username Ftp add_ftp user='username'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "add_ftp",
  • "module": "Ftp",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}