Return required but uninstalled server RPM package

This function lists RPMs that the server needs, but the server owner has not yet installed. When you call this function, it performs the same actions as the following command:

/usr/local/cpanel/scripts/check_cpanel_pkgs --list-only --targets[target]

For more information, read our rpm.versions system documentation.

SecurityBasicAuth
Request
query Parameters
target
string

The target that depends on the uninstalled RPMs. If you do not specify a value, the function lists all of the required but uninstalled RPMs for all RPM targets.

Example: target=3rdparty
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/list_rpms
Request samples
whmapi1 --output=jsonpretty \
  list_rpms
Response samples
application/json
{
  • "data": {
    • "rpms": [
      • "cpanel-pcre"
      ]
    },
  • "metadata": {
    • "command": "list_rpms",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}