cPanel API 2 Functions - Ftp::delftp

Warning:

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

Description

This function deletes an FTP account.

Warning:

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

Ftp::delete_ftp — This function deletes 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=delftp&user=user&destroy=1

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.

// Delete the FTP user "user" along with its home directory
$destroy_account = $cpanel->api2(
    'Ftp', 'delftp',
 array(
        'user' => 'user',
        'destroy' => '1',
 )
);

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.

# Delete the FTP user "user" along with its home directory
my $destroy_account = $cpliveapi->api2(
    'Ftp', 'delftp',
{
        'user' => 'user',
        'destroy' => '1',
   }
);

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 delftp user=user destroy=1

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": "delftp",
        "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

Parameters	Type	Description	Possible values	Example
`user`	string	Required The FTP account's username.	Any valid username.	`user`
`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`
`destroy`	Boolean	Required Whether to delete the account's FTP directory.	`1` — Delete the FTP directory. `0` — Maintain the `FTP` directory.	`1`

user

string

Required

The FTP account's username.

Any valid username.

user

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

destroy

Boolean

Required

Whether to delete the account's FTP directory.

1 — Delete the FTP directory.
0 — Maintain the FTP directory.

1

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