UAPI Functions - Ftp::delete_ftp

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

<!-- Delete an FTP account. -->
[% 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.

 
  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....