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

Description

This function installs, upgrades, or uninstalls RPM packages.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/package_manager_submit_actions?api.version=1&install=package1&install=package2&install=package3&uninstall=package4&uninstall=package5&upgrade=package6
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/package_manager_submit_actions?api.version=1&install=package1&install=package2&install=package3&uninstall=package4&uninstall=package5&upgrade=package6
 Command Line
whmapi1 package_manager_submit_actions install=package1 install=package2 install=package3 uninstall=package4 uninstall=package5 upgrade=package6

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":{  
      "build":9717
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"package_manager_submit_actions"
   }
}  
 Output (XML)
<result>
    <data>
        <build>9717</build>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>package_manager_submit_actions</command>
    </metadata>
</result>


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
installstring

The RPM package that you want to install.

Note:

$body

If you do not use this parameter, the function does not install a package.

A valid package name.

package1
uninstallstring

The RPM package that you want to uninstall.

Note:

$body

If you do not use this parameter, the function does not uninstall a package.


A valid package name.package4
upgradestring

The RPM package that you want to upgrade.

Note:

$body

If you do not use this parameter, the function does not upgrade a package.


A valid package name.

package6

 

Returns

ReturnTypeDescriptionPossible valuesExample
buildintegerA valid Process ID (PID).An integer value.9717