UAPI Functions - Ftp::delete_ftp - Knowledgebase

Description

This function deletes an FTP account.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Ftp/delete_ftp?user=weeones&destroy=1

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Delete an FTP user.
$kill_ftp = $cpanel->uapi(
    'Ftp', 'delete_ftp',
    array(
        'user'      => 'weeones',
        'destroy'   => '1',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Delete an FTP user.
my $kill_ftp = $cpliveapi->uapi(
    'Ftp', 'delete_ftp',
    {
        'user'      => 'weeones',
        'destroy'   => '1',
    }
);

cPanel Template Toolkit

[% execute( 'Ftp', 'delete_ftp', { 'user' => 'weeones', 'destroy' => '1' } ); %]

Command Line

uapi --user=username Ftp delete_ftp user=weeones destroy=1

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":null
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	The user's associated domain. Note: We introduced this parameter in cPanel & WHM version 54. This parameter defaults to the cPanel account's primary domain.	A domain that the cPanel account owns.	example.com
user	string	Required The FTP account's username.	An FTP username on the cPanel account.	weeones
destroy	Boolean	Whether to delete the FTP account's home directory. This value defaults to 0.	1 — Delete. 0 — Do not delete.	1

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories