Return available RPM packages information

This function retrieves information about the system's available RPM packages.

Note:

You must use either the ns or the package parameters.

SecurityBasicAuth
Request
query Parameters
ns
required
string

An available RPM package namespace.

Note:

  • ea and any from ea4_get_additional_pkg_prefixes API call are the only possible values.
  • If you use this parameter, you cannot use the package parameter.
  • To view more than one namespace, pass the parameter multiple times. For example, ns=ea and ns=altea.
Value: "ea" Examples:
ns=ns=ea ns=altea
ns=ea
package
required
string

An RPM package name on the system.

Note:

  • If you use this parameter, you cannot use the ns parameter.
  • To view more than one package, pass the parameter multiple times. For example, package=ea-php55 and package=ea-apr-util.
Examples:
package=package=ea-php55 package=ea-apr-util
package=ea-php55
disable-excludes
integer
Default: 0

Whether the system will disable yum's exclude behavior.

  • 1 — Disable yum's exclude behavior.
  • 0 — Do not disable yum's exclude behavior.
Enum: 1 0
Example: disable-excludes=1
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/package_manager_get_package_info
Request samples
whmapi1 --output=jsonpretty \
  package_manager_get_package_info \
  ns='ea' \
  package='ea-php55'
Response samples
application/json
{
  • "data": {
    • "packages": [
      • {
        • "architecture": "x86_64",
        • "license": "ASL 2.0",
        • "long_description": "The mission of the Apache Portable Runtime (APR) is to provide a\\nfree library of C data structures and routines.",
        • "more_info_url": "http://apr.apache.org",
        • "package": "ea-apr-util",
        • "pkg_dep": {
          • "conflicts": [
            • "ea-php55-php-ioncube5"
            ],
          • "requires": [
            • "glibc",
            • "libuuid",
            • "expat",
            • "libdb",
            • "ea-apr"
            ]
          },
        • "pkg_group": "System Environment/Libraries",
        • "release": "7.7.1.cpanel",
        • "repo_name": "NYI",
        • "short_description": "Apache Portable Runtime Utility library",
        • "size": 214647,
        • "state": "updatable",
        • "version": "1.6.1",
        • "version_installed": "1.6.1-4.4.8.cpanel",
        • "version_latest": "1.6.1-7.7.1.cpanel"
        }
      ]
    },
  • "metadata": {
    • "command": "package_manager_get_package_info",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}