UAPI Functions - SSH::get_port - Knowledgebase

Description

This function retrieves the server's SSH port.

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

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

// List the port that SSH listens to.

$get_port = $cpanel->uapi(

'SSH', 'get_port'

);

LiveAPI Perl Module

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

# List the port that SSH listens to.

my $get_port = $cpliveapi->uapi(

'SSH', 'get_port',

);

cPanel Template Toolkit

[% data = execute( 'SSH', 'get_port' ); %]

Command Line

uapi --user=username SSH get_port

Notes:

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

 Output (JSON)

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

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 server's SSH port.	A positive integer.	22

Knowledgebase

Categories

Categories