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

 

Description

This function lists of each available version of cPanel & WHM, and each version's latest maintenance release. This function also lists the cPanel & WHM version for each release tier.

Examples 


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

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": {
    "11.40": "11.40.1.22",
    "11.42": "11.42.1.28",
    "release": "11.46.0.14",
    "11.36": "11.36.2.12",
    "11.34": "11.34.2.8",
    "11.30": "11.30.8.0",
    "11.32": "11.32.7.3",
    "11.46": "11.46.0.14",
    "current": "11.46.0.14",
    "11.38": "11.38.2.23",
    "11.44": "11.44.1.21",
    "edge": "11.45.999.139",
    "stable": "11.44.1.21"
   },
   "metadata":{  
      "reason":"Got tiers list",
      "result":1,
      "command":"get_available_tiers",
      "version":1
   }
}
 Output (XML)
<result>
    <data>
        <11.40>11.40.1.22</11.40>
        <11.42>11.42.1.28</11.42>
        <release>11.46.0.14</release>
        <11.36>11.36.2.12</11.36>
        <11.34>11.34.2.8</11.34>
        <11.30>11.30.8.0</11.30>
        <11.32>11.32.7.3</11.32>
        <11.46>11.46.0.14</11.46>
        <current>11.46.0.14</current>
        <11.38>11.38.2.23</11.38>
        <11.44>11.44.1.21</11.44>
        <edge>11.45.999.139</edge>
        <stable>11.44.1.21</stable>
    </data>
    <metadata>
        <version>1</version>
        <reason>Got tiers list</reason>
        <result>1</result>
        <command>get_available_tiers</command>
    </metadata>
</result>

Note:

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

   

Parameters

This function does not accept parameters.

 

Returns

ReturnTypeDescriptionPossible valuesExample

VERSION NUMBER

string

The latest maintenance release for a cPanel & WHM version number.

Note:

The version number is the return's name.

A valid cPanel & WHM version number.
11.40.1.22

release

string

The version of cPanel & WHM that is currently on the RELEASE tier.

A valid cPanel & WHM version number.
11.46.0.14

stable

string

The version of cPanel & WHM that is currently on the STABLE tier.

A valid cPanel & WHM version number.
11.44.1.21

current

string

The version of cPanel & WHM that is currently on the CURRENT tier.

A valid cPanel & WHM version number.
11.46.0.14

edge

string

The version of cPanel & WHM that is currently on the EDGE tier.

A valid cPanel & WHM version number.
11.45.999.139