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

 

Description

This function lists the third-party software versions that ship with cPanel & WHM.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/installed_versions?api.version=1&packages=1
 Command Line
whmapi1 accountsummary packages=1

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":{  
      "nsd":0,
      "bind":"9.9.4-38",
      "munin":0,
      "operating_system_name":"centos",
      "mydns":0,
      "linux_kernel":"3.10.0-514.6.1.el7.x86_64",
      "proftpd":0,
      "cpanel_and_whm":"11.65.0.9999",
      "squirrelmail":"2012.12.09-3",
      "roundcube":"1.2.3-3",
      "cpanel_php":"5.6.30-2",
      "mailman":"2.1.23-8",
      "apache_php_default_version":0,
      "clamav":0,
      "apache":"2.4.12",
      "pureftpd":"1.0.42",
      "operating_system_version":"7.3",
      "dovecot":"2.2.28 (bed8434)",
      "easyapache":3,
      "powerdns":0,
      "openssh":"server-6.6.1p1-33",
      "ea_4_packages":[  

      ],
      "cpanel_packages":[  
         "cpanel-ace-editor-1.1.9-1.cp1152.noarch",
         "cpanel-analog-6.0-2.cp1136.x86_64",
         "cpanel-angular-chosen-1.4.0-1.cp1158.noarch",
...
         "cpanel-wwwcount-2.5-5.cp1136.x86_64",
         "cpanel-xdelta-1.1.4-1.cp1164.x86_64",
         "cpanel-yui-2.9.0-5.cp1136.noarch"
      ],
      "postgresql":0,
      "os_packages":[  
         "GeoIP-1.5.0-11.el7.x86_64",
         "ImageMagick-6.7.8.9-15.el7_2.x86_64",
         "ModemManager-glib-1.6.0-2.el7.x86_64",
         "MySQL55-client-5.5.54-1.cp1156.x86_64",
...
         "zlib-1.2.7-17.el7.x86_64",
         "zlib-devel-1.2.7-17.el7.x86_64",
         "zsh-5.0.2-25.el7_3.1.x86_64"
      ],
      "apache_php_versions":[  
         0
      ],
      "mysql":"5.5",
      "exim":"4.89-1",
      "horde":"5.2.10"
   },
   "metadata":{  
      "command":"installed_versions",
      "result":1,
      "reason":"OK",
      "version":1
    }
}

 

Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
packagesBoolean

Whether to list RPMs installed on the server.

This parameter defaults to 0.

  • 1 — List RPMs.
  • 0 — Do not list RPMs.
1

 

Returns

ReturnTypeDescriptionPossible valuesExample
software_namestring

The version of third-party software.

Note:

The parameter's name is the third-party software's name.

  • A valid string.
  • 0 — The software does not exist on the server.
9.9.4-38
apache_php_versions


array of strings

PHP versions installed with Apache.

  • A comma-separated list of strings.
  • 0 — No PHP versions installed.
5.5
ea_4_packages
array of strings

RPMs installed with EasyApache 4.

Note:

The function returns this array when the value of the packages parameter equals 1

  • A comma-separated list of strings.
  • 0 — No EasyApache 4 RPMs installed.
0
os_packages
array of strings

RPMs installed with the operating system.

Note:

The function returns this array when the value of the packages parameter equals 1

  • A comma-separated list of strings.
  • 0 — No operating system RPMs installed.
"GeoIP-1.5.0-11.el7.x86_64",
"ImageMagick-6.7.8.9-15.el7_2.x86_64",
"ModemManager-glib-1.6.0-2.el7.x86_64"
cpanel_packages
array of strings

RPMs installed with cPanel & WHM.

Note:

The function returns this array when the value of the packages parameter equals 1

  • A comma-separated list of strings.
  • 0 — No cPanel & WHM RPMs installed.
"cpanel-ace-editor-1.1.9-1.cp1152.noarch",
"cpanel-analog-6.0-2.cp1136.x86_64",
"cpanel-angular-chosen-1.4.0-1.cp1158.noarch"