UAPI Functions - Ftp::ftp_exists - Knowledgebase

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

 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',
    )
);

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

cPanel Template Toolkit

[% execute( 'Ftp', 'ftp_exists', { 'user' => 'us_chickens' } ); %]

Command Line

uapi --user=username Ftp ftp_exists user=us_chickens

Notes:

You must URI-encode values.
username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	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
user	string	Required The FTP account's username.	An FTP username on the cPanel account.	us_chickens

Parameter

Type

Description

Possible values

Example

domain

string

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

user

string

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.

Knowledgebase

Categories

Categories