This function deletes an FTP account.
Important:
When you disable the FTP role, the system disables this function.
user required | string The FTP account's username. Example: user=username |
destroy | integer Default: 0 Whether to delete the FTP account's home directory.
Example: destroy=1 |
domain | string <domain> The user's associated domain. Note: This parameter defaults to the cPanel account's primary domain. Example: domain=example.com |
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 delete_ftp user='username'
{- "apiversion": 3,
- "func": "delete_ftp",
- "module": "Ftp",
- "result": {
- "data": null,
- "errors": null,
- "messages": null,
- "metadata": { },
- "status": 1,
- "warnings": null
}
}