# 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.

Endpoint: GET /Ftp/list_sessions
Version: 11.136.0.19
Security: BasicAuth

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "list_sessions"

  - `module` (string)
    The name of the module called.
    Example: "Ftp"

  - `result` (object)

  - `result.data` (array)

  - `result.data.cmdline` (string)
    Information about the FTP process, from the ps ([process status](http://www.linfo.org/ps.html)) command.
    Example: "pure-ftpd (IDLE)"

  - `result.data.file` (string)
    The file that the session is processing.

Note:

The function returns a blank value if the session is idle.

  - `result.data.host` (any)
    The IP address or hostname that connected to the FTP server.
    Example: "localhost"

  - `result.data.login` (string)
    The FTP session login time.
    Example: "Tue Apr 23 16:23:23 2020"

  - `result.data.pid` (integer)
    The session's PID.
    Example: 6735

  - `result.data.status` (string)
    The session's status.
- IDLE - The session is connected, but idle.
- DL - A download is in progress.
- UL - An upload is in progress.
    Enum: "IDLE", "DL", "UL"

  - `result.data.user` (string)
    The FTP account username.
    Example: "ftpaccount"

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    - 1 - Success.
- 0 - Failed. Check the errors field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.