Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Ftp
FTP Accounts

Delete FTP account

This function deletes an FTP account.

Important:

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

get/Ftp/delete_ftp

Query parameters

userstring required
Example:username

The FTP account's username.

destroy0 | 1
Example:1

Whether to delete the FTP account's home directory.

  • 1 — Delete the home directory.
  • 0 — Do not delete the home directory.
domainstring domain
Example:example.com

The user's associated domain.

Note:

This parameter defaults to the cPanel account's primary domain.

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": "delete_ftp",
  "module": "Ftp",
  "result": {
    "status": 1
  }
}