Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function checks whether an FTP account exists.

Note:

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 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/ftp_exists?user=us_chickens

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$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',
    )
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
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',
    }
);

Note:

For more information, read our Guide to the LiveAPI System.

 

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

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Ftp ftp_exists user=us_chickens

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{  
   "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
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The user's associated domain.

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

Note:

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.