Child pages
  • UAPI Functions - SSH::get_port
Skip to end of metadata
Go to start of metadata

 

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


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.
 
// List the port that SSH listens to.
$get_port = $cpanel->uapi(
    'SSH', 'get_port'
);


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.
 
# List the port that SSH listens to.
my $get_port = $cpliveapi->uapi(
    'SSH', 'get_port',
);


Note:

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

 

 cPanel Template Toolkit
<!-- Retrieve the port that SSH listens to. -->
[% data = execute( 'SSH', 'get_port' ); %]


Note:

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

 

 Command Line
uapi --user=username SSH get_port


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. 

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "port": "22"
  }
}


Note:

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

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
portinteger

The server's SSH port.

A positive integer.

22