v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Ftp

FTP Server Settings

Return FTP server's active sessions

This function lists the FTP server's active sessions.

Important:

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

get/Ftp/list_sessions

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_sessions",
  "module": "Ftp",
  "result": {
    "data": [
      {
        "cmdline": "pure-ftpd (IDLE)",
        "login": "Tue Apr 23 16:23:23 2020",
        "pid": 6735,
        "status": "IDLE",
        "user": "ftpaccount"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}