UAPI Functions - Ftp::server_name - Knowledgebase

Description

This function checks whether the server uses ProFTPD or Pure-FTPd.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Ftp/server_name

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Check the server's FTP server.

$ftp_server = $cpanel->uapi(

'Ftp', 'server_name'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Check the server's FTP server.

my $ftp_server = $cpliveapi->uapi(

'Ftp', 'server_name',

);

cPanel Template Toolkit

[% execute( 'Ftp', 'server_name' ); %]

Command Line

uapi --user=username Ftp server_name

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": "pure-ftpd"
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
data	string	The FTP server.	pure-ftpd proftpd	pure-ftpd

Return

Type

Description

Possible values

Example

data

string

The FTP server.

pure-ftpd
proftpd

pure-ftpd

Knowledgebase

Categories

Categories