Description

This function deletes an FTP account.

Examples 




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



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

 



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

 



<!-- Delete an FTP account. -->
[% execute( 'Ftp', 'delete_ftp', { 'user' => 'weeones', 'destroy' => '1' } ); %]

 



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



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

   },
   "data":null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
domain string

The user's associated domain.

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
userstring

Required

The FTP account's username.

An FTP username on the cPanel account.

weeones
destroyBoolean

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.