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.

Authorizations:
query Parameters
user
required
string

The FTP account's username.

Example: user=us_chickens
domain
string <domain>

The user's associated domain.

Note:

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

Example: domain=example.com

Responses

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

Request samples

uapi --user=username Ftp ftp_exists user='us_chickens'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "ftp_exists",
  • "module": "Ftp",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}