Skip to content
cPanel API 2 Modules
/
cPanel API 2 Modules - FTP
/
cPanel API 2 Functions - Ftp::listftpsessions
Last updated

cPanel API 2 Functions - Ftp::listftpsessions

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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:

Important:

When you disable the FTP role, the system disables this function.

Examples

WHM API (JSON)

syntaxhighlighter-pre
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
Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

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

// List the account's active FTP sessions.
$list_ftpsesions = $cpanel->api2(
    'Ftp', 'listftpsessions'
);
Note:

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

LiveAPI Perl Module

syntaxhighlighter-pre
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',
);
Note:

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

cPanel Tag System (deprecated)

Warnings:
  • cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

syntaxhighlighter-pre
cpapi2 --user=username Ftp listftpsessions
Notes:

  • You must URI-encode values.

  • username represents your account-level username.

  • You must include the --user=username option.

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

  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    syntaxhighlighter-pre
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

syntaxhighlighter-pre
{
 "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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
pidstringThe session's process ID.A positive integer.833623
statusstringThe session's status.
  • IDLE — The session is idle.
  • UL — The client is uploading a file.
  • DL — The client is downloading a file.
IDLE
userstringThe session's FTP user.A valid username.example
filestringThe file that the FTP daemon is processing.
  • blank — The session is idle.
  • A valid filename. — The daemon is transferring a file.
example.html
cmdlinestring

A session status that the ps command generates.

A valid string.pure-ftpd (IDLE)
loginstringThe session's login time.A string in extended date format.Wed Oct 15 12:49:03 2014
hoststringThe FTP client's hostname.A valid hostname.hostname.example.com
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1
Previous page
Next page