UAPI Functions - Ftp::get_port - Knowledgebase

Description

This function returns the FTP port.

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

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

// Check the server's FTP port number.

$ftp_server = $cpanel->uapi(

'Ftp', 'get_port'

);

LiveAPI Perl Module

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

# Check the server's FTP port number.

my $ftp_server = $cpliveapi->uapi(

'Ftp', 'get_port',

);

cPanel Template Toolkit

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

Command Line

uapi --user=username Ftp get_port

Notes:

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

 Output (JSON)

{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":{ 
      "port":21
   }
}

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
port	integer	The FTP port.	A positive integer that represents a port number. Note: Generally, this function returns port 21.	21

Return

Type

Description

Possible values

Example

port

integer

The FTP port.

A positive integer that represents a port number.

Note:

Generally, this function returns port 21.

Knowledgebase

Categories

Categories