Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - Ftp::delete_ftp - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - Ftp::delete_ftp
Skip to end of metadata
Go to start of metadata

Description

This function deletes an FTP account.

Important:

In cPanel & WHM version 76 and later, when you disable the FTP role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


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


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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


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 an FTP user.
my $kill_ftp = $cpliveapi->uapi(
    'Ftp', 'delete_ftp',
    {
        'user'      => 'weeones',
        'destroy'   => '1',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
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
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.