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.

SecurityBasicAuth

Request

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: `anonymous` `logaccess` `main` `sub` Example: include_acct_types=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 not exclude any account types. Valid types for this list are: `anonymous` `logaccess` `main` `sub` Example: skip_acct_types=main\|anonymous

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Ftp/list_ftp_with_disk

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Ftp \
  list_ftp_with_disk

Response samples

application/json

{"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",
"diskquota": "476.84",
"diskused": "2.34",
"diskusedpercent": 21,
"diskusedpercent20": 20,
"htmldir": null,
"humandiskquota": "477 MB",
"humandiskused": "2 MB",
"login": "ftpaccount",
"reldir": "public_ftp",
"serverlogin": "ftpaccount@example.com"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}