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
cPanel API 1 Functions - Ftp::kill_ftp_session - Developer Documentation - cPanel Documentation
Child pages
  • cPanel API 1 Functions - Ftp::kill_ftp_session
Skip to end of metadata
Go to start of metadata

 

Description

This function kills an active FTP session.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$kill_ftp = $cpanel->api1('Ftp','kill_ftp_session',array('12345') ); // Call the function.


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.
my $kill_ftp = $cpliveapi->api1('Ftp','kill_ftp_session',['12345'] ); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Ftp::kill_ftp_session( $FORM('pid'))">
 Command Line
cpapi1 --user=username Ftp kill_ftp_session 12345

Note:

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

 Output (none)
This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
pidstring

Required

The FTP session's process identification number (PID).

  • A valid PID number — Kill a single FTP session.
  • all — Kill all of the account's FTP sessions.
12345

Returns

This function does not return output.