cPanel API 2 Functions - Ftp::listftpsessions - Knowledgebase

Description

This function lists an account's active FTP sessions.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Ftp::list_sessions — This function lists the FTP server's active sessions.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Ftp&cpanel_jsonapi_func=listftpsessions

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List the account's active FTP sessions.

$list_ftpsesions = $cpanel->api2(

'Ftp', 'listftpsessions'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List the account's active FTP sessions.

my $list_ftpsessions = $cpliveapi->api2(

'Ftp', 'listftpsessions',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username Ftp listftpsessions

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
 "cpanelresult": {
    "apiversion": 2,
    "func": "listftpsessions",
    "data": [
      {
        "pid": "833623",
        "status": "IDLE",
        "user": "example",
        "file": "example.html",
        "cmdline": "pure-ftpd (IDLE)",
        "login": "Wed Oct 15 12:49:03 2014",
        "host": "hostname.example.com"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Ftp"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
pid	string	The session's process ID.	A positive integer.	833623
status	string	The session's status.	IDLE — The session is idle. UL — The client is uploading a file. DL — The client is downloading a file.	IDLE
user	string	The session's FTP user.	A valid username.	example
file	string	The file that the FTP daemon is processing.	blank — The session is idle. A valid filename. — The daemon is transferring a file.	example.html
cmdline	string	A session status that the ps command generates.	A valid string.	pure-ftpd (IDLE)
login	string	The session's login time.	A string in extended date format.	Wed Oct 15 12:49:03 2014
host	string	The FTP client's hostname.	A valid hostname.	hostname.example.com
reason	string	A reason for failure. Note: This function only returns a reason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories