Child pages
  • UAPI Functions - Ftp::kill_session
Skip to end of metadata
Go to start of metadata

Description

This function kills FTP sessions.

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/kill_session?login=weeones


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.
 
// Kill the user's FTP session.
$kill_ftp = $cpanel->uapi(
    'Ftp', 'kill_session',
    array(
        'login'      => 'weeones',
    )
);
 
// Kill FTP sessions for all users.
$kill_ftp = $cpanel->uapi(
    'Ftp', 'kill_session',
    array(
        'login'      => 'all',
    )
);


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.
 
# Kill the user's FTP session.
my $kill_ftp = $cpliveapi->uapi(
    'Ftp', 'kill_session',
    {
        'login'      => 'weeones',
    }
);
 
# Kill FTP sessions for all users.
my $kill_ftp = $cpliveapi->uapi(
    'Ftp', 'kill_session',
    {
        'login'      => 'all',
    }
);


Note:

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

 cPanel Template Toolkit
<!-- Kill FTP sessions for an FTP account. -->
[% execute( 'Ftp', 'kill_session', { 'login' => 'weeones' } ); %]
 
<!-- Kill all FTP sessions. -->
[% execute( 'Ftp', 'kill_session', { 'login' => 'all' } ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Ftp kill_session login=weeones


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
loginstring

The username for the session's FTP account.

This parameter defaults to all.

  • all — Stops all FTP sessions for the cPanel account.
  • An FTP account username, to stop only that user's session.
weeones

Returns

This function only returns metadata.