We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - Variables::get_session_information
Skip to end of metadata
Go to start of metadata

Description

This function retrieves a web server's hostname.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Variables/get_session_information?name=host


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.
 
//Retrieve web server session information for example.com.
$variables = $cpanel->uapi(
    'Variables', 'get_session_information',
    array(
        'name' => 'host',
        )
);


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.
 
# Retrieve session settings for example.com.
my $variables = $cpliveapi->uapi(
    'Variables', 'get_session_information',
    {
        'name' => 'host',
    }
);


Note:

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

 Command Line
uapi --user=username Variables get_session_information name=host 


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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
    "data" : {
        "host" : "server1.com",

    },


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
namestring

The web server environment variable to retrieve. You can only retrieve the web server's hostname.

This parameter defaults to host

host is the only possible value.host 


Returns

ReturnTypeDescriptionPossible valuesExample

host

 
string

The HTTP server value.

The function only returns this value if you call the function via a web browser.

A valid hostname.server1.com