Description

This function deletes an FTP account.

Examples


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$delete_ftpuser = $cpanel->api1('Ftp','delftp',array('user','1') ); // Call the function.

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $delete_ftpuser = $cpliveapi->api1('Ftp','delftp',['user','1'] ); # Call the function.

 

<cpanel Module="Ftp::delftp($FORM('user','destroy'))">
cpapi1 --user=username Ftp delftp user

For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.  

This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The FTP username.

A valid FTP username on the account.

user
destroyBoolean

Whether to delete the FTP account's home directory.

This value defaults to 0.

  • 1 — Delete the FTP account's home directory.
  • 0 — Leave FTP user's files intact.
1

Returns

This function does not return output.