cPanel API 2 Functions - Ftp::addftp - Knowledgebase

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.

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

 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',
 )
);

 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',
   }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

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

 Output (JSON)

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

Note:

Use cPanel's API Shell interface (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
quota	integer	The new FTP account's quota.	A positive integer. 0 — Unlimited quota.	12345
homedir	string	The path to the user's home directory.	A valid path, relative to the account's home directory.	userftp

Returns

Return	Type	Description	Possible values	Example
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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

Return

Type

Description

Possible values

Example

reason

string

A reason for failure.

Note:

This function only returns a reasonvalue 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.

Knowledgebase

Categories

Categories