---
title: "Return filtered hosting plans"
method: GET
path: "/matchpkgs"
tags: ["Packages", "Hosting Plans"]
---

# Return filtered hosting plans

`GET /matchpkgs`

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.

## Query parameters

- `_PACKAGE_EXTENSIONS` string
- `BWLIMIT` union
  - integer
  - 'unlimited' — The hosting plan allows unlimited bandwidth.
- `CGI` 1 | 0
- `CPMOD` string
- `DIGESTAUTH` 'y' | 'n'
- `FEATURELIST` string
- `HASSHELL` 1 | 0
- `IP` 'y' | 'n'
- `LANG` string, ISO-3166-1 (alpha-2)
- `MAX_DEFER_FAIL_PERCENTAGE` union
  - integer
  - 'unlimited' — The hosting plan allows unlimited email messages.
- `MAX_EMAIL_PER_HOUR` union
  - integer
  - 'unlimited' — The hosting plan allows unlimited emails per hour.
- `MAX_EMAILACCT_QUOTA` union
  - integer
  - 'unlimited' — The hosting plan allows an unlimited email account quota size.
- `MAX_TEAM_USERS` integer, nullable
- `MAXADDON` union
  - integer
  - 'unlimited' — The hosting plan allows unlimited addon domains.
- `MAXFTP` union
  - integer
  - 'unlimited' — The hosting plan allows for unlimited FTP accounts.
- `MAXLST` union
  - integer
  - 'unlimited' — The hosting plan allows an unlimited number of mailing lists.
- `MAXPARK` union
  - integer
  - 'unlimited' — The hosting plan allows unlimited parked domains.
- `MAXPOP` union
  - integer
  - 'unlimited' — The hosting plan's can create unlimited email accounts.
- `MAXSQL` union
  - integer
  - 'unlimited' — The hosting plan allows unlimited SQL databases.
- `MAXSUB` union
  - integer
  - 'unlimited' — The hosting plan allows unlimited subdomains.
- `QUOTA` union
  - integer
  - 'unlimited' — The hosting plan has unlimited disk space.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `pkg` object — A list of hosting plan settings.
      - `BWLIMIT` union — The hosting plan's bandwidth limit, in megabytes (MB). * `unlimited` — The hosting plan allows unlimited bandwidth.
        - integer
        - 'unlimited' — The hosting plan allows unlimited bandwidth.
      - `CGI` 1 | 0 — Whether CGI is enabled for the hosting plan. * `1` — Enabled. * `0` — Disabled.
      - `CPMOD` string — The hosting plan's cPanel interface theme.
      - `DIGESTAUTH` 'y' | 'n' — Whether the hosting plan enables Digest Authentication. * `y` — Enable. * `n` — Disable.
      - `FEATURELIST` string — The hosting plan's [feature list](https://go.cpanel.net/whmdocsFeatureManager).
      - `FRONTPAGE` 0 — Whether Microsoft® FrontPage Extensions are enabled for the account. **Note:** cPanel & WHM ignores all FrontPage settings and parameters.
      - `HASSHELL` 'y' | 'n' — Whether shell access is enabled for the hosting plan. * `y` — Enabled. * `n` — Disabled.
      - `IP` 'y' | 'n' — Whether the hosting plan grants accounts a dedicated IP address. * `y` — Dedicated IP address. * `n` — Shared IP address.
      - `LANG` string, ISO-3166-1 (alpha-2) — The hosting plan's locale.
      - `MAXADDON` union — The hosting plan's maximum number of addon domains. * `unlimited` — The hosting plan allows unlimited addon domains.
        - integer
        - 'unlimited' — The hosting plan allows unlimited addon domains.
      - `MAXFTP` union — The hosting plan's maximum number of FTP accounts. * `unlimited` — The hosting plan allows for unlimited FTP accounts.
        - integer
        - 'unlimited' — The hosting plan allows for unlimited FTP accounts.
      - `MAXLST` union — The hosting plan's maximum number of mailing lists. * `unlimited` — The hosting plan allows an unlimited number of mailing lists.
        - integer
        - 'unlimited' — The hosting plan allows an unlimited number of mailing lists.
      - `MAXPARK` union — The hosting plan's maximum number of parked domains. * `unlimited` — The hosting plan allows unlimited parked domains.
        - integer
        - 'unlimited' — The hosting plan allows unlimited parked domains.
      - `MAXPOP` union — The hosting plan's maximum number of email accounts. * `unlimited` — The hosting plan's can create unlimited email accounts.
        - integer
        - 'unlimited' — The hosting plan's can create unlimited email accounts.
      - `MAXSQL` union — The hosting plan's maximum number of SQL databases. * `unlimited` — The hosting plan allows unlimited SQL databases.
        - integer
        - 'unlimited' — The hosting plan allows unlimited SQL databases.
      - `MAXSUB` union — The hosting plan's maximum number of subdomains. * `unlimited` — The hosting plan allows unlimited subdomains.
        - integer
        - 'unlimited' — The hosting plan allows unlimited subdomains.
      - `MAX_DEFER_FAIL_PERCENTAGE` union — The [percentage of failed or deferred email messages](https://go.cpanel.net/howtopreventspam) that the hosting plan can send per hour before outgoing mail is rate-limited. * `unlimited` — The hosting plan allows unlimited email messages.
        - integer
        - 'unlimited' — The hosting plan allows unlimited email messages.
      - `MAX_EMAILACCT_QUOTA` union — The maximum size that the account can define when it creates an email account. * `unlimited` — The hosting plan allows an unlimited email account quota size.
        - integer
        - 'unlimited' — The hosting plan allows an unlimited email account quota size.
      - `MAX_EMAIL_PER_HOUR` union — The [maximum number of emails](https://go.cpanel.net/howtopreventspam) that the hosting plan can send in one hour. * `unlimited` — The hosting plan allows unlimited emails per hour.
        - integer
        - 'unlimited' — The hosting plan allows unlimited emails per hour.
      - `QUOTA` union — The hosting plan's disk space limit. * `unlimited` — The hosting plan has unlimited disk space.
        - integer
        - 'unlimited' — The hosting plan has unlimited disk space.
      - `_PACKAGE_EXTENSIONS` string — A list of one or more of the hosting plan's package extensions.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 1 | 0 — * `1` – Success. * `0` – Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)