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 determines whether a branch's Long-Term Support (LTS) version expires within three months. For more information about LTS, read our cPanel Long-Term Support documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_current_lts_expiration_status
- A server running WHM.
https://whm-server.tld:2087/json-api/get_current_lts_expiration_status
- 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_current_lts_expiration_statusResponse
application/json
{ "data": { "expiration": 1585612801, "expires_in_next_three_months": 0, "full_version": "11.88.1.11" }, "metadata": { "command": "get_current_lts_expiration_status", "reason": "OK", "result": 1, "version": 1 } }
Request
This function parses the /etc/cpanel/TIERS.json file and returns whether a branch qualifies for Long-Term Support (LTS). For more information about LTS, read our cPanel Long-Term Support documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_lts_wexpire
- A server running WHM.
https://whm-server.tld:2087/json-api/get_lts_wexpire
- 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_lts_wexpireResponse
application/json
{ "data": { "branch": { … }, "flags": { … }, "tiers": { … } }, "metadata": { "command": "get_lts_wexpire", "reason": "OK", "result": 1, "version": 1 } }
Request
This function checks whether your server uses the latest version of cPanel & WHM for your release tier.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_update_availability
- A server running WHM.
https://whm-server.tld:2087/json-api/get_update_availability
- 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_update_availabilityResponse
application/json
{ "data": { "current_version": "88.0.12", "newest_version": "88.0.12", "tier": "current", "update_available": 0 }, "metadata": { "command": "get_update_availability", "reason": "OK", "result": 1, "version": 1 } }