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 sets the importance level of an application event for WHM's Contact Manager interface (WHM >> Home >> Server Contacts >> Contact Manager).
For a list of available modules, use the WHM API 1 get_all_contact_importances function.
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/set_application_contact_event_importance
- A server running WHM.
https://whm-server.tld:2087/json-api/set_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/set_application_contact_event_importance?app=Check&event=SecurityAdvisorStateChange&importance=Disabled'Response
application/json
{ "metadata": { "command": "set_application_contact_event_importance", "reason": "OK", "result": 1, "version": 1 } }
Request
This function sets the importance level of an application's events for WHM's Contact Manager interface (WHM >> Home >> Server Contacts >> Contact Manager).
For a list of available modules, use the WHM API 1 get_all_contact_importances function.
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/set_application_contact_importance
- A server running WHM.
https://whm-server.tld:2087/json-api/set_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/set_application_contact_importance?app=Check&importance=Disabled'Response
application/json
{ "metadata": { "command": "set_application_contact_importance", "reason": "OK", "result": 1, "version": 1 } }
Request
This function updates the contact email address in the wwwacct.conf file. For more information, read our Installation Guide - Customize Your Installation documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/update_contact_email
- A server running WHM.
https://whm-server.tld:2087/json-api/update_contact_email
- 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/update_contact_email?contact_email=user%40example.com'Response
application/json
{ "metadata": { "command": "update_contact_email", "reason": "OK", "result": 1, "version": 1 } }