Child pages
  • cPanel API 2 Functions - Ftp::listftpsessions

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function lists an account's active FTP sessions.


Warning
titleWarning:

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

  • Ftp::list_sessions

    Excerpt Include
    DD:UAPI Functions - Ftp::list_sessions
    DD:UAPI Functions - Ftp::list_sessions
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledFTPRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the account's active FTP sessions.
$list_ftpsesions = $cpanel->api2(
    'Ftp', 'listftpsessions'
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username Ftp listftpsessions

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
 "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"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

This function does not accept parameters.

Returns

Return TypeDescriptionPossible 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.

Note
titleNote:

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