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 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 } }
Request
This function calls the WHM API 1 send_test_posturl function for your specified POST notification URLs. Users can specify POST notification URLs in the Contact Information section of WHM's Basic WebHost Manager Setup interface (WHM >> Home >> Server Configuration >> Basic WebHost Manager Setup).
Note:
If the Contact Information section of WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup) contains multiple POST URLs, the function will return an array that contains the results for each URL.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/verify_posturl_access
- A server running WHM.
https://whm-server.tld:2087/json-api/verify_posturl_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_posturl_accessResponse
application/json
{ "data": { "results": [ … ] }, "metadata": { "command": "verify_posturl_access", "reason": "OK", "result": 1, "version": 1 } }
Request
This function calls the WHM API 1 send_test_pushbullet_note function with the system's specified Pushbullet™ accounts. You can specify Pushbullet 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_pushbullet_access
- A server running WHM.
https://whm-server.tld:2087/json-api/verify_pushbullet_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_pushbullet_accessResponse
application/json
{ "data": { "results": [ … ] }, "metadata": { "command": "verify_pushbullet_access", "reason": "OK", "result": 1, "version": 1 } }