cPanel API 2 Functions - Ftp::addftp

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function creates an FTP account.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Ftp::add_ftp — This function creates an FTP account.

Important:

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

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Ftp&cpanel_jsonapi_func=addftp&user=user&pass=12345luggage&quota=12345&homedir=userftp

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Add new FTP user "user" with password "12345luggage"
$add_ftp = $cpanel->api2(
    'Ftp', 'addftp',
 array(
        'user'    => 'newuser',
        'pass'    => '12345luggage',
        'quota'   => '12345',
        'homedir' => 'newuserftp',
 )
);

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Add new FTP user "user" with password "12345luggage"
my $add_ftp = $cpliveapi->api2(
    'Ftp', 'addftp',
{
        'user'    => 'newuser',
        'pass'    => '12345luggage',
        'quota'   => '12345',
        'homedir' => 'newuserftp',
   }
);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username Ftp addftp user=user pass=12345luggage

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
    "cpanelresult": {
        "apiversion": 2,
        "func": "addftp",
        "data": [{
            "reason": "OK",
            "result": 1
        }],
        "event": {
            "result": 1
        },
        "module": "Ftp"
    }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameters	Type	Description	Possible values	Example
`user`	string	Required The FTP account's username.	A valid username.	`user`
`pass`	string	Required The new password.	A valid password.	`12345luggage`
`domain`	string	The user's associated domain. This parameter defaults to the cPanel account's primary domain.	A domain that the cPanel account owns.	`example.com`
`quota`	integer	The new FTP account's quota. This value defaults to `0`, which grants an unlimited quota.	A positive integer. `0` — Unlimited quota.	`12345`
`homedir`	string	The path to the user'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 account's home directory.	`userftp`

Returns

Return Type Description Possible values Example

Return	Type	Description	Possible values	Example
`reason`	string	A reason for failure. This function only returns a `reason` value if it failed.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`

reason

string

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.

result

Boolean

Whether the function succeeded.

1 — The function succeeded.
0 — The function failed.

1