cPanel API 2 Functions - Ftp::delftp - Knowledgebase

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.

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

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

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

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": "delftp",
    "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.	Any valid username.	user
destroy	boolean	Required Whether to delete the FTP directory of the account.	1 — Delete the home directory. 0 — Maintain the home directory.	1

Parameters

Type

Description

Possible values

Example

user

string

Required

The FTP account's username.

Any valid username.

user

destroy

boolean

Required

Whether to delete the FTP directory of the account.

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

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