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/
Request
This function returns a list of addon domains that belong to the current user.
Important: When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/convert_addon_list_addon_domains
- A server running WHM.
https://whm-server.tld:2087/json-api/convert_addon_list_addon_domains
- 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/convert_addon_list_addon_domainsResponse
application/json
{ "data": { "example.com": { … } }, "metadata": { "command": "convert_addon_list_addon_domains", "reason": "OK", "result": 1, "version": 1 } }
Request
This function returns a list of addon domains undergoing conversion into cPanel accounts.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/convert_addon_list_conversions
- A server running WHM.
https://whm-server.tld:2087/json-api/convert_addon_list_conversions
- 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/convert_addon_list_conversionsResponse
application/json
{ "data": { "conversions": [ … ] }, "metadata": { "command": "convert_addon_list_conversions", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/domainuserdata
- A server running WHM.
https://whm-server.tld:2087/json-api/domainuserdata
- 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/domainuserdata?domain=example.com'Response
application/json
{ "data": { "userdata": { … } }, "metadata": { "command": "domainuserdata", "reason": "Obtained userdata.", "result": 1, "version": 1 } }