Create

Create a new FTP User.

The password for the FTP user will be generated.

Note: it is only guaranteed that the provided username will appear in the username of the FTP user. It will not by definition be the case that it will match exactly.

This action requires a request with an active account.

Tokens

This action requires the following tokens:

  • ftp-user-write

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
username String   Desired username for the new FTP user, which will be used to generate a username for this FTP user

Output

This action produces the following output on success:

An object containing the following fields:

Name Type Description
username String The username for this FTP user
password String The password for this FTP user
account

The account to which the FTP user belongs

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_FTP_USER_ALREADY_EXISTS (420)
If the FTP user with the given username already exists