v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Ftp

FTP Accounts

Return FTP accounts and disk usage

This function lists FTP account and disk usage information.

Important:

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

get/Ftp/list_ftp_with_disk

Query parameters

include_acct_typesstring

Example:main|anonymous

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:

anonymous
logaccess
main
sub

skip_acct_typesstring

Example:main|anonymous

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 not exclude any account types.

Valid types for this list are:

anonymous
logaccess
main
sub

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_ftp_with_disk",
  "module": "Ftp",
  "result": {
    "data": [
      {
        "_diskquota": "476.84",
        "_diskused": "2.34",
        "accttype": "sub",
        "deleteable": 1,
        "dir": "/home/user/public_ftp",
        "diskused": "2.34",
        "diskusedpercent": 21,
        "diskusedpercent20": 20,
        "humandiskquota": "477 MB",
        "humandiskused": "2 MB",
        "login": "ftpaccount",
        "reldir": "public_ftp",
        "serverlogin": "ftpaccount@example.com"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}