Child pages
  • cPanel API 1 Functions - Ftp::delftp

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function deletes an FTP account.

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)Ftp::delete_ftp
    Excerpt Include
    UAPI Functions - Ftp::delete_ftp
    UAPI Functions - Ftp::delete_ftp
    nopaneltrue
  • cPanel API 2Ftp::delftp
    Excerpt Include
    cPanel API 2 Functions - Ftp::delftp
    cPanel API 2 Functions - Ftp::delftp
    nopaneltrue
Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$delete_ftpuser = $cpanel->api1('Ftp','delftp',array('user','1') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

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

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Ftp::delftp($FORM('user','destroy'))">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Ftp delftp user
Note
titleNote:

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

Expand
titleOutput (none)
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.