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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/delete_featurelist
- A server running WHM.
https://whm-server.tld:2087/json-api/delete_featurelist
- 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/delete_featurelist?featurelist=TestList'Response
application/json
{ "data": { "deleted_featurelist": "TestList" }, "metadata": { "command": "delete_featurelist", "reason": "OK", "result": 1, "version": 1 } }
Request
This function returns the contents of a dynamicui file. For more information, read our Guide to WHM dynamicui Files documentation.
Security
BasicAuth
Query
A comma-separated list of the application entries to return.
To determine the application's name, find its file value in the dynamicui.conf file, and then remove the file extension.
If you do not specify this value, the function returns the entire dynamicui.conf file.
Example: applications_list=create_support_ticket
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_available_applications
- A server running WHM.
https://whm-server.tld:2087/json-api/get_available_applications
- 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/get_available_applications?applications_list=create_support_ticket&file=dynamicui.conf'Response
application/json
{ "data": { "groups": [ … ], "raw": [ … ] }, "metadata": { "command": "get_available_applications", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_feature_metadata
- A server running WHM.
https://whm-server.tld:2087/json-api/get_feature_metadata
- 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/get_feature_metadataResponse
application/json
{ "data": { "features": [ … ] }, "metadata": { "command": "get_feature_metadata", "reason": "OK", "result": 1, "version": 1 } }