Sign in
latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Packages
Hosting Plans

Create hosting plan

This function creates a hosting plan (package).

Note:

The Access Control Lists restricts some of this function's parameters, which limit the features that WHM users can access.

get/addpkg

Query parameters

namestring required
Example:package1

The new hosting plan's name.

Note:

  • You cannot use the name extensions for a hosting plan.
  • You cannot modify hosting plan names after creation. Do not include details that may change over time, such as price.
_PACKAGE_EXTENSIONSstring
Example:'extension1 extension2 extension3'

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

If you do not provide a value, the hosting plan will not include package extensions.

Note:

  • We strongly recommend that you manage package extensions through WHM API 1's addpkgext and delpkgext functions.
  • You can include the extension's variables in your function call, in key=value format. Consult the extension's documentation for a list of possible variables.
  • Extension names and variables are case-sensitive.
integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:2:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited bandwidth."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:2:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

The hosting plan's maximum bandwidth use, in megabytes (MB).

  • 0, unlimited, or null — The hosting plan allows unlimited bandwidth.

Note:

The 0, unlimited, and null values are only available to users that possess the corresponding unlimited ACL permission.

cgi1 | 0
Example:1

Whether CGI access is enabled for the account.

  • 1 — Enabled.
  • 0 — Disabled.

Note:

When a server profile disables the Web Server role, this parameter defaults to 0. On these servers, you cannot enable CGI access.

cpmodstring
Example:jupiter

The hosting plan's cPanel theme.

This parameter defaults to the server's default cPanel theme.

digestauth1 | 0
Example:1

Whether to enable Digest Authentication for accounts on the hosting plan.

  • 1 — Enable.
  • 0 — Disable.
featureliststring
Example:feature_list

The hosting plan's feature list.

If you do not use this parameter, the function assigns the default feature list to the account.

frontpage1 | 0

Whether Microsoft® FrontPage® Extensions are enabled for the account.

  • 1 — Enabled.
  • 0 — Disabled.

Note:

cPanel & WHM ignores all FrontPage settings and parameters.

hasshell1 | 0
Example:1

Whether the hosting plan allows shell access.

  • 1 — The hosting plan allows shell access.
  • 0 — The hosting plan does not allows shell access.
ip'y' | 'n'
Example:n

Whether the account has a dedicated IP address.

  • y — The account possesses a dedicated IP address.
  • n — The account does not possess a dedicated IP address.
languagestring ISO-3166-1 (alpha-2)
Example:en

The hosting plan's default locale, in its two-letter ISO-3166 code format.

This parameter defaults to the server's default locale.

integer
OR
'unlimited'

The hosting plan allows users ot send an unlimited number of failed or deferred messages.

The percentage of failed or deferred email messages that the hosting plan allows users to send per hour before outgoing mail is rate-limited.

  • 0 or unlimited — The hosting plan allows users ot send an unlimited number of failed or deferred messages.
integer
OR
'unlimited'

The hosting plan allows users to send an unlimited number of emails.

The maximum number of emails that the hosting plan allows users to send in one hour.

  • 0 or unlimited — The hosting plan allows users to send an unlimited number of emails.
integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:13:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited email account quota."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:13:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

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

  • 0, unlimited, or null — The hosting plan allows unlimited email account quota.

Note:

The 0, unlimited, and null values are only available to users that possess the corresponding unlimited ACL permission.

max_team_usersinteger
Example:7

The hosting plan's maximum number of Team users.

integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:15:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited addon domains."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:15:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

The hosting plan's maximum number of addon domains.

  • unlimited or null — The hosting plan allows unlimited addon domains.
integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:16:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited FTP accounts."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:16:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

The hosting plan's maximum number of FTP accounts.

  • unlimited, or null — The hosting plan allows unlimited FTP accounts.
integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:17:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited mailing lists."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:17:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

The hosting plan's maximum number of mailing lists.

  • unlimited, or null — The hosting plan allows unlimited mailing lists.
integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:18:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited parked domains."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:18:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

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

  • unlimited or null — The hosting plan allows unlimited parked domains.
integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:19:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited email accounts."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:19:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

The hosting plan's maximum number of email accounts.

  • unlimited, or null — The hosting plan allows unlimited email accounts.
integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:20:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited databases."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:20:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

The hosting plan's maximum number of each available type of SQL database.

For example, if you set this value to 5 and the system administrator allows MySQL® and PostgreSQL® databases, users can create up to five MySQL databases and up to five PostgreSQL databases.

  • unlimited, or null — The hosting allows unlimited databases.
integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:21:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited subdomains."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:21:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

The hosting plan's maximum number of subdomains.

  • unlimited, or null — The hosting plan allows unlimited subdomains.
integer
OR
{"stackTrail":"paths:/addpkg:get:parameters:22:schema:oneOf:1","oasType":"schema","type":"unknown","description":"The hosting plan allows unlimited disk space."}
OR
{"stackTrail":"paths:/addpkg:get:parameters:22:schema:oneOf:2","oasType":"schema","type":"unknown"}
OR
'unlimited'

The hosting plan's disk space quota, in megabytes (MB).

  • 0, unlimited, or null — The hosting plan allows unlimited disk space.

Note:

The 0, unlimited, and null values are only available to users that possess the corresponding unlimited ACL permission.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "pkg": "package1"
  },
  "metadata": {
    "command": "addpkg",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}