---
title: "Return FTP server's active sessions"
method: GET
path: "/Ftp/list_sessions"
tags: ["Ftp", "FTP Server Settings"]
---

# Return FTP server's active sessions

`GET /Ftp/list_sessions`

This function lists the FTP server's active sessions.

**Important:**

  When you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[]
      - `cmdline` string — Information about the FTP process, from the `ps` ([process status](http://www.linfo.org/ps.html)) command.
      - `file` string — The file that the session is processing. **Note:** The function returns a blank value if the session is idle.
      - `host` union — The IP address or hostname that connected to the FTP server.
        - string, ipv4
        - string, domain
      - `login` string — The FTP session login time.
      - `pid` integer — The session's PID.
      - `status` 'IDLE' | 'DL' | 'UL' — The session's status. - `IDLE` - The session is connected, but idle. - `DL` - A download is in progress. - `UL` - An upload is in progress.
      - `user` string — The FTP account username.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 0 | 1 — - `1` - Success. - `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)