v1

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

Return whether an FTP account exists

This function checks whether an FTP account exists.

Note:

This function returns only metadata if the FTP account exists, or an error if the FTP account does not exist.

get/Ftp/ftp_exists

Query parameters

userstring required
Example:us_chickens

The FTP account's username.

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