cPanel API 1 Functions - Ftp::addftp - Knowledgebase

Description

This function creates a new FTP account.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Ftp::add_ftp — This function creates an FTP account.
cPanel API 2 — Ftp::addftp — This function creates an FTP account.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$add_ftp = $cpanel->api1('Ftp','addftp', array('user','12345luggage','usernameftp','0','0','public_html/usernameftp') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $add_ftp = $cpliveapi->api1('Ftp','addftp', ['user','12345luggage','usernameftp','0','0','public_html/usernameftp'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Ftp::addftp( $FORM('user','pass','homedir','quota','disallowdot','homedir2'))">

Command Line

cpapi1 --user=username Ftp addftp

Note:

For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
user	string	Required The FTP username.	A valid FTP username on the account.	user
pass	string	Required The FTP password.	A secure password.	12345luggage
homedir	string	The FTP account's home directory. If you do not specify a path, the FTP account uses the cPanel account's home directory.	A valid path, relative to the cPanel account's home directory.	public_ftp
quota	Boolean	The quota of the new FTP account. This value defaults to 0, which grants an unlimited quota.	A valid integer which measures the quota size, in bytes. 0 — An unlimited quota.	0
disallowdot	Boolean	Whether to strip the dots from the username. This value defaults to 1.	1 — Strip dots from the username. 0 — Allow dots in the username.	0
homedir2	string	Note: We deprecated this parameter in cPanel & WHM version 11.

Returns

This function does not return output.

Knowledgebase

Categories

Categories