Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves the server's hostname.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/gethostname?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/gethostname?api.version=1
 Command Line
whmapi1 gethostname

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
  "data": {
    "hostname": "hostname.example.com"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "gethostname"
  }
}
 Output (XML)
<result>
    <data>
        <hostname>hostname.example.com</hostname>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>gethostname</command>
    </metadata>
</result>

Note:

Use WHM's API Shell interface (Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

hostname

string

The server's hostname.

A valid hostname.hostname.example.com