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 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 } }
Request
This function calls WHM API 1's verify_oscar_access function with your specified ICQ accounts. You can specify ICQ accounts in the Contact Information section of WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup).
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/verify_icq_access
- A server running WHM.
https://whm-server.tld:2087/json-api/verify_icq_access
- 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/verify_icq_accessResponse
application/json
{ "data": { "message_id": "554d2cbd-efe61da3cacb" }, "metadata": { "command": "verify_icq_access", "reason": "OK", "result": 1, "version": 1 } }
Request
This function tests the ICQ credentials that the system uses for notifications. The system generates a unique string and includes it in the test message.
You can also review the user's ICQ message history to confirm that the server sent and received the message.
The test's success or failure depends on the following conditions:
- Valid username and password combination.
- Network configuration.
- Service outages.
- External server rate limit.
Warning:
AOL discontinued support for AIM in December 2017. This function only tests ICQ credentials, not AIM credentials.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/verify_oscar_access
- A server running WHM.
https://whm-server.tld:2087/json-api/verify_oscar_access
- 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/verify_oscar_access?password=12345luggage&username=username'Response
application/json
{ "data": { "message_id": "554d2cbd-efe61da3cacb" }, "metadata": { "command": "verify_oscar_access", "reason": "OK", "result": 1, "version": 1 } }