# Return FTP accounts and disk usage

This function lists FTP account and disk usage information.



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

Endpoint: GET /Ftp/list_ftp_with_disk
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `include_acct_types` (string)
    A pipe-delimited list of the FTP account types to include in the function's results.
If you do not specify this parameter, the function returns all FTP account types.

Valid types for this list are:

* 
* 
* 
*
    Example: "main|anonymous"

  - `skip_acct_types` (string)
    A pipe-delimited list of the FTP account types to exclude from the function's
results. If you do not specify this parameter, the function does  exclude
any account types.

Valid types for this list are:

* 
* 
* 
*
    Example: "main|anonymous"

## Response 200 fields (application/json):

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

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

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

  - `result` (object)

  - `result.data` (array)

  - `result.data._diskquota` (string)
    The FTP account's quota in megabytes, with two digits of fractional precision,
encoded as a string.  means that the quota is unlimited.



This value is different from the value for .
    Example: "476.84"

  - `result.data._diskused` (string)
    The amount of disk space in megabytes that the account currently uses,
with two digits of fractional precision, encoded as a string.



This value is the same as the value for .
    Example: "2.34"

  - `result.data.accttype` (string)
    The type of FTP account.

* 
* 
* 
*
    Enum: "anonymous", "logaccess", "main", "sub"

  - `result.data.deleteable` (integer)
    Whether the function's caller can delete the account.

*  – The caller can delete the account.
*  – The caller  delete the account.
    Enum: 0, 1

  - `result.data.dir` (string)
    The absolute path to the FTP account's document root.
    Example: "/home/user/public_ftp"

  - `result.data.diskquota` (any)
    The FTP account's quota.

* 
* The disk quota in megabytes, with two digits of fractional precision, encoded as a string.



This value is different from the value for .
    Example: "476.84"

  - `result.data.diskused` (string)
    The amount of disk space in megabytes that the account currently uses,
with two digits of fractional precision, encoded as a string.



This value is the same as the value for .
    Example: "2.34"

  - `result.data.diskusedpercent` (integer)
    The percentage of the disk space quota that the account currently uses.
    Example: 21

  - `result.data.diskusedpercent20` (integer)
    The percentage of disk space that the account currently uses, rounded in 20 percent increments.
    Example: 20

  - `result.data.htmldir` (string,null)
    The path to the FTP account's HTML directory.

  - `result.data.humandiskquota` (string)
    The FTP account's quota, in human-readable format.

*  — The function returns this value if the account has an unlimited quota.
* The quota in megabytes (MB), a space, and the characters .
    Example: "477 MB"

  - `result.data.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 .
    Example: "2 MB"

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

  - `result.data.reldir` (string)
    The path to the FTP account's document root,
relative to the cPanel account's home directory.
    Example: "public_ftp"

  - `result.data.serverlogin` (string)
    The full FTP login username.
    Example: "ftpaccount@example.com"

  - `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 a API.