cPanel API 1 Functions - Ftp::kill_ftp_session - Knowledgebase

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:

UAPI (recommended) — Ftp::kill_session — This function kills FTP sessions.
cPanel API 2 — None.

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.

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.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

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 pid=12345

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
pid	string	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

Parameter

Type

Description

Possible values

Example

pid

string

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.

Knowledgebase

Categories

Categories