WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Query
The permissions of packages that you wish to list.
all— All packages on the system.creatable— Packages that the authenticated user can use for accounts.editable— Packages that the authenticated user can edit.viewable— Packages that the authenticated user can view.
Default "all"
Enum"all""creatable""editable""viewable"
Example: want=all
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/listpkgs
- A server running WHM.
https://whm-server.tld:2087/json-api/listpkgs
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/listpkgs?want=all'Response
application/json
{ "data": { "pkg": [ … ] }, "metadata": { "command": "listpkgs", "reason": "OK", "result": 1, "version": 1 } }
Query
A space-separated list of one or more of the hosting plan's package extensions.
Example: _PACKAGE_EXTENSIONS='ext1 ext2 ext3'
The hosting plan's bandwidth limit.
unlimited— The hosting plan allows unlimited bandwidth.
Example: BWLIMIT=unlimited
One of:
>= 0
integer(megabytes)>= 0
Whether CGI is enabled for the hosting plan.
1— Enabled.0— Disabled.
Enum10
Example: CGI=1
Whether the hosting plan enables Digest Authentication.
y— Enabled.n— Disabled.
Enum"y""n"
Example: DIGESTAUTH=n
Whether shell access is enabled for the hosting plan.
1— Enabled0— Disabled.
Enum10
Example: HASSHELL=1
Whether the hosting plan grants accounts a dedicated IP address.
y— Dedicated IP address.n— Shared IP address.
Enum"y""n"
Example: IP=n
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
One of:
>= 0
integer>= 0
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
One of:
>= 0
integer>= 0
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
One of:
>= 1
integer(megabytes)>= 1
The hosting plan's maximum number of Team users.
Example: MAX_TEAM_USERS=7
The hosting plan's maximum number of addon domains.
unlimited— The hosting plan allows unlimited addon domains.
Example: MAXADDON=unlimited
One of:
>= 0
integer>= 0
The hosting plan's maximum number of FTP accounts.
unlimited— The hosting plan allows for unlimited FTP accounts.
Example: MAXFTP=2
One of:
>= 0
integer>= 0
The hosting plan's maximum number of mailing lists.
unlimited— The hosting plan allows an unlimited number of mailing lists.
Example: MAXLST=unlimited
One of:
>= 0
integer>= 0
The hosting plan's maximum number of parked domains (aliases).
unlimited— The hosting plan allows unlimited parked domains.
Example: MAXPARK=unlimited
One of:
>= 0
integer>= 0
The hosing plan's maximum number of email accounts.
unlimited— The hosting plan's can create unlimited email accounts.
Example: MAXPOP=unlimited
One of:
>= 0
integer>= 0
The hosting plan's maximum number of SQL databases.
unlimited— The hosting plan allows unlimited SQL databases.
Example: MAXSQL=unlimited
One of:
>= 0
integer>= 0
The hosting plan's maximum number of subdomains.
unlimited— The hosting plan allows unlimited subdomains.
Example: MAXSUB=unlimited
One of:
>= 0
integer>= 0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/matchpkgs
- A server running WHM.
https://whm-server.tld:2087/json-api/matchpkgs
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/matchpkgs?_PACKAGE_EXTENSIONS=%27ext1+ext2+ext3%27&BWLIMIT=unlimited&CGI=1&CPMOD=jupiter&DIGESTAUTH=n&FEATURELIST=myfeaturelist&HASSHELL=1&IP=n&LANG=en&MAX_DEFER_FAIL_PERCENTAGE=unlimited&MAX_EMAIL_PER_HOUR=unlimited&MAX_EMAILACCT_QUOTA=unlimited&MAX_TEAM_USERS=7&MAXADDON=unlimited&MAXFTP=2&MAXLST=unlimited&MAXPARK=unlimited&MAXPOP=unlimited&MAXSQL=unlimited&MAXSUB=unlimited"A=unlimited'Response
application/json
{ "data": { "pkg": { … } }, "metadata": { "command": "matchpkgs", "reason": "OK", "result": 1, "version": 1 } }