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 lists the importance of all application events in WHM's Contact Manager interface (WHM >> Home >> Server Contacts >> Contact Manager).
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_all_contact_importances
- A server running WHM.
https://whm-server.tld:2087/json-api/get_all_contact_importances
- 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_all_contact_importancesResponse
application/json
{ "data": { "importances": [ … ] }, "metadata": { "command": "get_all_contact_importances", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_application_contact_event_importance
- A server running WHM.
https://whm-server.tld:2087/json-api/get_application_contact_event_importance
- 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_application_contact_event_importance?app=Check&event=SecurityAdvisorStateChange'Response
application/json
{ "data": { "importance": 0, "name": "Disabled" }, "metadata": { "command": "get_application_contact_event_importance", "reason": "OK", "result": 1, "version": 1 } }
Request
This function retrieves the importance level of an application's events for WHM's Contact Manager interface (WHM >> Home >> Server Contacts >> Contact Manager).
Note:
The system creates a notification setting for the application's events if one does not already exist.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_application_contact_importance
- A server running WHM.
https://whm-server.tld:2087/json-api/get_application_contact_importance
- 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_application_contact_importance?app=Check'Response
application/json
{ "data": { "importance": 0, "name": "Disabled" }, "metadata": { "command": "get_application_contact_importance", "reason": "OK", "result": 1, "version": 1 } }