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.
include_acct_types | string A list of the FTP account types to include in the function's results.
If you do not specify this parameter, this function returns all FTP account types. Note:
Example: include_acct_types=main|anonymous |
skip_acct_types | string A list of the FTP account types to exclude from the function's results.
If you do not specify this parameter, this function does not exclude any account types. Note:
Example: skip_acct_types=main|anonymous |
apiversion | integer The version of the API. |
func | string The name of the method called. |
module | string The name of the module called. |
object |
uapi --user=username Ftp list_ftp
{- "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
}
}