Sign in
latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Packages
Hosting Plans

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.

get/matchpkgs

Query parameters

_PACKAGE_EXTENSIONSstring
Example:'ext1 ext2 ext3'

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

integer
OR
'unlimited'

The hosting plan allows unlimited bandwidth.

The hosting plan's bandwidth limit.

  • unlimited — The hosting plan allows unlimited bandwidth.
CGI1 | 0
Example:1

Whether CGI is enabled for the hosting plan.

  • 1 — Enabled.
  • 0 — Disabled.
CPMODstring
Example:jupiter

The hosting plan's cPanel interface theme.

DIGESTAUTH'y' | 'n'
Example:n

Whether the hosting plan enables Digest Authentication.

  • y — Enabled.
  • n — Disabled.
FEATURELISTstring
Example:myfeaturelist

The hosting plan's feature list.

HASSHELL1 | 0
Example:1

Whether shell access is enabled for the hosting plan.

  • 1 — Enabled
  • 0 — Disabled.
IP'y' | 'n'
Example:n

Whether the hosting plan grants accounts a dedicated IP address.

  • y — Dedicated IP address.
  • n — Shared IP address.
LANGstring ISO-3166-1 (alpha-2)
Example:en

The hosting plan's locale.

integer
OR
'unlimited'

The hosting plan allows unlimited email messages.

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.
integer
OR
'unlimited'

The hosting plan allows unlimited emails per hour.

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

  • unlimited — The hosting plan allows unlimited emails per hour.
integer
OR
'unlimited'

The hosting plan allows an unlimited email account quota size.

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

  • unlimited — The hosting plan allows an unlimited email account quota size.
MAX_TEAM_USERSinteger nullable
Example:7

The hosting plan's maximum number of Team users.

integer
OR
'unlimited'

The hosting plan allows unlimited addon domains.

The hosting plan's maximum number of addon domains.

  • unlimited — The hosting plan allows unlimited addon domains.
integer
OR
'unlimited'

The hosting plan allows for unlimited FTP accounts.

The hosting plan's maximum number of FTP accounts.

  • unlimited — The hosting plan allows for unlimited FTP accounts.
integer
OR
'unlimited'

The hosting plan allows an unlimited number of mailing lists.

The hosting plan's maximum number of mailing lists.

  • unlimited — The hosting plan allows an unlimited number of mailing lists.
integer
OR
'unlimited'

The hosting plan allows unlimited parked domains.

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

  • unlimited — The hosting plan allows unlimited parked domains.
integer
OR
'unlimited'

The hosting plan's can create unlimited email accounts.

The hosing plan's maximum number of email accounts.

  • unlimited — The hosting plan's can create unlimited email accounts.
integer
OR
'unlimited'

The hosting plan allows unlimited SQL databases.

The hosting plan's maximum number of SQL databases.

  • unlimited — The hosting plan allows unlimited SQL databases.
integer
OR
'unlimited'

The hosting plan allows unlimited subdomains.

The hosting plan's maximum number of subdomains.

  • unlimited — The hosting plan allows unlimited subdomains.
integer
OR
'unlimited'

The hosting plan has unlimited disk space.

The hosting plan's disk space limit.

  • unlimited — The hosting plan has unlimited disk space.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "pkg": {
      "CGI": 1,
      "CPMOD": "jupiter",
      "DIGESTAUTH": "y",
      "FEATURELIST": "myfeaturelist",
      "HASSHELL": "n",
      "IP": "n",
      "LANG": "en",
      "_PACKAGE_EXTENSIONS": "ext1 ext2 ext3"
    }
  },
  "metadata": {
    "command": "matchpkgs",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}