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/add_override_features_for_user
- A server running WHM.
https://whm-server.tld:2087/json-api/add_override_features_for_user
- 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/add_override_features_for_user?features={%22backup%22%3A1}&user=username'Response
application/json
{ "metadata": { "command": "add_override_features_for_user", "reason": "OK", "result": 1, "version": 1 } }
Query Examples:
The user's username.
Note:
To check multiple users, increment the parameter name. For example, user-1, user-2, and user-3.
Multiple users.
A single user.
The feature's name.
Note:
- To check multiple features, increment the parameter name. For example,
feature-1,feature-2, andfeature-3. - If you use this parameter, you must enter a feature name, or the function returns an error. If you do not use this parameter, the function returns data for all features on the server.
Multiple feature.
A single feature.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_users_features_settings
- A server running WHM.
https://whm-server.tld:2087/json-api/get_users_features_settings
- 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_users_features_settings?user=string&feature=string'Response
application/json
{ "data": { "users_features_settings": [ … ] }, "metadata": { "command": "get_users_features_settings", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/remove_override_features_for_user
- A server running WHM.
https://whm-server.tld:2087/json-api/remove_override_features_for_user
- 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/remove_override_features_for_user?features=%5B%22sslinstall%22%2C%22videotut%22%5D&user=username'Response
application/json
{ "metadata": { "command": "remove_override_features_for_user", "reason": "OK", "result": 1, "version": 1 } }