Description

This function checks whether an FTP account exists.

This function does not return a Boolean value to indicate whether the FTP account exists. Instead, it returns only metadata if the FTP account exists, or an error if the FTP account does not exist. 

Examples 


https://hostname.example.com:2083/cpsess##########/execute/Ftp/ftp_exists?user=us_chickens

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Check whether an FTP user exists.
$check_ftp = $cpanel->uapi(
    'Ftp', 'ftp_exists',
    array(
        'user'      => 'us_chickens',
    )
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Check whether an FTP user exists.
my $check_ftp = $cpliveapi->uapi(
    'Ftp', 'ftp_exists',
    {
        'user'      => 'us_chickens',
    }
);

 

<!-- Check whether the FTP account exists. -->
[% execute( 'Ftp', 'ftp_exists', { 'user' => 'us_chickens' } ); %]

 

uapi --user=username Ftp ftp_exists user=us_chickens

{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}
{  
   "messages":null,
   "errors":[  
      "The FTP account "us_chickens" does not exist."
   ],
   "status":0,
   "metadata":{  

   },
   "data":null
}

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The user's associated domain.

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

We introduced this parameter in cPanel & WHM version 54.

A domain that the cPanel account owns.example.com
userstring

Required

The FTP account's username.

An FTP username on the cPanel account.

us_chickens

Returns

  • If the FTP account exists, this function only returns metadata.
  • If the FTP account does not exist, this function returns the following error message, where user represents the FTP account that you checked:

    The FTP account "user" does not exist.