Return FTP accounts

This function lists FTP account information.

Important:

When you disable the FTP role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

SecurityBasicAuth

Request

query Parameters

include_acct_types	string A list of the FTP account types to include in the function's results. `anonymous` `logaccess` `main` `sub` If you do not specify this parameter, this function returns all FTP account types. Note: Separate multiple types with the pipe character (`\|`). In browser-based calls, use `%7C`. Example: include_acct_types=main\|anonymous
skip_acct_types	string A list of the FTP account types to exclude from the function's results. `anonymous` `logaccess` `main` `sub` If you do not specify this parameter, this function does not exclude any account types. Note: Separate multiple types with the pipe character (`\|`). In browser-based calls, use `%7C`. 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

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

{"apiversion": 3,
"func": "list_ftp",
"module": "Ftp",
"result": {"data": [{"homedir": "/home/user/public_html/ftp/",
"type": "main",
"user": "ftpaccount"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}