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
  • WHM API 1 Functions - get_available_tiers
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:

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

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
      "11.62":"11.62.0.48",
      "11.48":"11.48.5.3",
      "11.52":"11.52.6.6",
      "11.80":"11.80.0.24",
      "11.44":"11.44.3.5",
      "11.72":"11.72.0.12",
      "11.58":"11.58.0.52",
      "11.42":"11.42.1.31",
      "11.74":"11.74.0.12",
      "11.68":"11.68.0.39",
      "11.78":"11.78.0.46",
      "11.64":"11.64.0.42",
      "11.54":"11.54.0.36",
      "11.30":"11.30.8.0",
      "current":"11.86.0.3",
      "11.36":"11.36.2.12",
      "edge":"11.86.0.3",
      "11.86":"11.86.0.3",
      "11.60":"11.60.0.48",
      "11.50":"11.50.6.2",
      "11.82":"11.82.0.19",
      "11.34":"11.34.2.8",
      "11.38":"11.38.2.23",
      "11.70":"11.70.0.69",
      "11.40":"11.40.1.22",
      "stable":"11.84.0.21",
      "11.32":"11.32.7.3",
      "11.84":"11.84.0.21",
      "11.46":"11.46.4.0",
      "release":"11.84.0.21",
      "11.66":"11.66.0.35",
      "11.56":"11.56.0.52",
      "lts":"11.78.0.46",
      "11.76":"11.76.0.22"
   },
   "metadata":{  
      "reason":"Got tiers list",
      "result":1,
      "command":"get_available_tiers",
      "version":1
   }
}
 Output (XML)
<result>
    <data>
      <11.62>11.62.0.48</11.62>,
      <11.48>11.48.5.3</11.48>,
      <11.52>11.52.6.6</11.52>,
      <11.80>11.80.0.24</11.80>,
      <11.44>11.44.3.5</11.44>,
      <11.72>11.72.0.12</11.72>,
      <11.58>11.58.0.52</11.58>,
      <11.42>11.42.1.31</11.42>,
      <11.74>11.74.0.12</11.74>,
      <11.68>11.68.0.39</11.68>,
      <11.78>11.78.0.46</11.78>,
      <11.64>11.64.0.42</11.64>,
      <11.54>11.54.0.36</11.54>,
      <11.30>11.30.8.0</11.30>,
      <current>11.86.0.3</current>,
      <11.36>11.36.2.12</11.36>,
      <edge>11.86.0.3</edge>,
      <11.86>11.86.0.3</11.86>,
      <11.60>11.60.0.48</11.60>,
      <11.50>11.50.6.2</11.50>,
      <11.82>11.82.0.19</11.83>,
      <11.34>11.34.2.8</11.34>,
      <11.38>11.38.2.23</11.38>,
      <11.70>11.70.0.69</11.70>,
      <11.40>11.40.1.22</11.40>,
      <stable>11.84.0.21</stable>,
      <11.32>11.32.7.3</11.32>,
      <11.84>11.84.0.21</11.84>,
      <11.46>11.46.4.0</11.46>,
      <release>11.84.0.21</release>,
      <11.66>11.66.0.35</11.66>,
      <11.56>11.56.0.52</11.56>,
      <lts>11.78.0.46</lts>,
      <11.76>11.76.0.22</11.76>
    </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.80.0.24

release

string

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

A valid cPanel & WHM version number.
11.84.0.21

stable

string

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

A valid cPanel & WHM version number.
11.84.0.21

current

string

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

A valid cPanel & WHM version number.
11.86.0.3

edge

string

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

A valid cPanel & WHM version number.
11.86.0.3
lts stringThe version of cPanel & WHM that is currently on the LTS tier.A valid cPanel & WHM version number.11.78.0.46