Return filtered hosting plans

This function matches the server's hosting plans (packages) against your criteria.

Note:

If you do not include any input parameters, the function lists all of the server's packages.

Authorizations:
query Parameters
_PACKAGE_EXTENSIONS
string

A space-separated list of one or more of the hosting plan's package extensions.

Example: _PACKAGE_EXTENSIONS='ext1 ext2 ext3'
integer or string

The hosting plan's bandwidth limit.

  • unlimited — The hosting plan allows unlimited bandwidth.
Example: BWLIMIT=unlimited
CGI
integer

Whether CGI is enabled for the hosting plan.

  • 1 — Enabled.
  • 0 — Disabled.
Enum: 1 0
Example: CGI=1
CPMOD
string

The hosting plan's cPanel interface theme.

Example: CPMOD=paper_lantern
DIGESTAUTH
string

Whether the hosting plan enables Digest Authentication.

  • y — Enabled.
  • n — Disabled.
Enum: "y" "n"
Example: DIGESTAUTH=n
FEATURELIST
string

The hosting plan's feature list.

Example: FEATURELIST=myfeaturelist
HASSHELL
integer

Whether shell access is enabled for the hosting plan.

  • 1 — Enabled
  • 0 — Disabled.
Enum: 1 0
Example: HASSHELL=1
IP
string

Whether the hosting plan grants accounts a dedicated IP address.

  • y — Dedicated IP address.
  • n — Shared IP address.
Enum: "y" "n"
Example: IP=n
LANG
string <ISO-3166-1 (alpha-2)>

The hosting plan's locale.

Example: LANG=en
integer or string

The percentage of failed or deferred email messages that the hosting plan can send per hour before the system rate-limits outgoing mail.

  • unlimited — The hosting plan allows unlimited email messages.
Example: MAX_DEFER_FAIL_PERCENTAGE=unlimited
integer or string

The maximum number of emails that the hosting plan can send in one hour.

  • unlimited — The hosting plan allows unlimited emails per hour.
Example: MAX_EMAIL_PER_HOUR=unlimited
integer or string

The hosting plan's maximum email account quota size, in megabytes (MB).

  • unlimited — The hosting plan allows an unlimited email account quota size.
Example: MAX_EMAILACCT_QUOTA=unlimited
integer or string

The hosting plan's maximum number of addon domains.

  • unlimited — The hosting plan allows unlimited addon domains.
Example: MAXADDON=unlimited
integer or string

The hosting plan's maximum number of FTP accounts.

  • unlimited — The hosting plan allows for unlimited FTP accounts.
Example: MAXFTP=2
integer or string

The hosting plan's maximum number of mailing lists.

  • unlimited — The hosting plan allows an unlimited number of mailing lists.
Example: MAXLST=unlimited
integer or string

The hosting plan's maximum number of parked domains (aliases).

  • unlimited — The hosting plan allows unlimited parked domains.
Example: MAXPARK=unlimited
integer or string

The hosing plan's maximum number of email accounts.

  • unlimited — The hosting plan's can create unlimited email accounts.
Example: MAXPOP=unlimited
integer or string

The hosting plan's maximum number of SQL databases.

  • unlimited — The hosting plan allows unlimited SQL databases.
Example: MAXSQL=unlimited
integer or string

The hosting plan's maximum number of subdomains.

  • unlimited — The hosting plan allows unlimited subdomains.
Example: MAXSUB=unlimited
integer or string

The hosting plan's disk space limit.

  • unlimited — The hosting plan has unlimited disk space.
Example: QUOTA=unlimited

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  matchpkgs

Response samples

Content type
application/json
{
  • "data": {
    • "pkg": {
      • "BWLIMIT": "unlimited",
      • "CGI": 1,
      • "CPMOD": "paper_lantern",
      • "DIGESTAUTH": "y",
      • "FEATURELIST": "myfeaturelist",
      • "FRONTPAGE": 0,
      • "HASSHELL": "n",
      • "IP": "n",
      • "LANG": "en",
      • "MAXADDON": 1,
      • "MAXFTP": "unlimited",
      • "MAXLST": 5,
      • "MAXPARK": 1,
      • "MAXPOP": 20,
      • "MAXSQL": 1,
      • "MAXSUB": 5,
      • "MAX_DEFER_FAIL_PERCENTAGE": 10,
      • "MAX_EMAILACCT_QUOTA": "unlimited",
      • "MAX_EMAIL_PER_HOUR": 100,
      • "QUOTA": 100,
      • "_PACKAGE_EXTENSIONS": "ext1 ext2 ext3"
      }
    },
  • "metadata": {
    • "command": "matchpkgs",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}