---
title: "Return FTP accounts and disk usage"
method: GET
path: "/Ftp/list_ftp_with_disk"
tags: ["Ftp", "FTP Accounts"]
---

# Return FTP accounts and disk usage

`GET /Ftp/list_ftp_with_disk`

This function lists FTP account and disk usage information.

**Important:**

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

## Query parameters

- `include_acct_types` string
- `skip_acct_types` string

## 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[]
      - `_diskquota` string, ^\d+\.\d+$ — The FTP account's quota in megabytes, with two digits of fractional precision, encoded as a string. `0.00` means that the quota is unlimited. **Note:** This value is different from the value for `diskquota`.
      - `_diskused` string, ^\d+\.\d+$ — The amount of disk space in megabytes that the account currently uses, with two digits of fractional precision, encoded as a string. **Note:** This value is the same as the value for `diskused`.
      - `accttype` 'anonymous' | 'logaccess' | 'main' | 'sub' — The type of FTP account. * `anonymous` * `logaccess` * `main` * `sub`
      - `deleteable` 0 | 1 — Whether the function's caller can delete the account. * `1` – The caller can delete the account. * `0` – The caller **cannot** delete the account.
      - `dir` string — The absolute path to the FTP account's document root.
      - `diskquota` union — The FTP account's quota. * `unlimited` * The disk quota in megabytes, with two digits of fractional precision, encoded as a string. **Note:** This value is different from the value for `_diskquota`.
        - 'unlimited'
        - string, ^\d+\.\d+$
      - `diskused` string, ^\d+\.\d+$ — The amount of disk space in megabytes that the account currently uses, with two digits of fractional precision, encoded as a string. **Note:** This value is the same as the value for `_diskused`.
      - `diskusedpercent` integer — The percentage of the disk space quota that the account currently uses.
      - `diskusedpercent20` integer — The percentage of disk space that the account currently uses, rounded in 20 percent increments.
      - `htmldir` string, nullable — The path to the FTP account's HTML directory.
      - `humandiskquota` string — The FTP account's quota, in human-readable format. * `None` — The function returns this value if the account has an unlimited quota. * The quota in megabytes (MB), a space, and the characters `MB`.
      - `humandiskused` string — The amount of disk space that the account currently uses, in human-readable format. The function formats this value as the quota's size, a space, and the characters `MB`.
      - `login` string — The FTP account username.
      - `reldir` string — The path to the FTP account's document root, relative to the cPanel account's home directory.
      - `serverlogin` string — The full FTP login 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 a 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)