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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/accept_eula
- A server running WHM.
https://whm-server.tld:2087/json-api/accept_eula
- 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/accept_eulaResponse
application/json
{ "metadata": { "command": "accept_eula", "reason": "OK", "result": 1, "version": 1 } }
Request
This function lists of each available version of cPanel & WHM, and each version's latest maintenance release. This function also lists the cPanel & WHM version for each release tier.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_available_tiers
- A server running WHM.
https://whm-server.tld:2087/json-api/get_available_tiers
- 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_available_tiersHTTP Request was successful.
A list of the latest available version of cPanel & WHM.
Example: {"11.30":"11.30.8.0","11.32":"11.32.7.3","11.34":"11.34.2.8","11.36":"11.36.2.12","11.38":"11.38.2.23","11.40":"11.40.1.22","11.42":"11.42.1.31","11.44":"11.44.3.5","11.46":"11.46.4.0","11.48":"11.48.5.3","11.50":"11.50.6.2","11.52":"11.52.6.6","11.54":"11.54.0.36","11.56":"11.56.0.52","11.58":"11.58.0.52","11.60":"11.60.0.48","11.62":"11.62.0.48","11.64":"11.64.0.42","11.66":"11.66.0.35","11.68":"11.68.0.39","11.70":"11.70.0.69","11.72":"11.72.0.12","11.74":"11.74.0.12","11.76":"11.76.0.22","11.78":"11.78.0.49","11.80":"11.80.0.24","11.82":"11.82.0.19","11.84":"11.84.0.22","11.86":"11.86.0.24","11.88":"11.88.0.13","11.90":"11.90.0.3","current":"11.90.0.3","edge":"11.90.0.3","lts":"11.86.0.24","release":"11.88.0.13","stable":"11.88.0.13"}
Response
application/json
{ "data": { "11.30": "11.30.8.0", "11.32": "11.32.7.3", "11.34": "11.34.2.8", "11.36": "11.36.2.12", "11.38": "11.38.2.23", "11.40": "11.40.1.22", "11.42": "11.42.1.31", "11.44": "11.44.3.5", "11.46": "11.46.4.0", "11.48": "11.48.5.3", "11.50": "11.50.6.2", "11.52": "11.52.6.6", "11.54": "11.54.0.36", "11.56": "11.56.0.52", "11.58": "11.58.0.52", "11.60": "11.60.0.48", "11.62": "11.62.0.48", "11.64": "11.64.0.42", "11.66": "11.66.0.35", "11.68": "11.68.0.39", "11.70": "11.70.0.69", "11.72": "11.72.0.12", "11.74": "11.74.0.12", "11.76": "11.76.0.22", "11.78": "11.78.0.49", "11.80": "11.80.0.24", "11.82": "11.82.0.19", "11.84": "11.84.0.22", "11.86": "11.86.0.24", "11.88": "11.88.0.13", "11.90": "11.90.0.3", "current": "11.90.0.3", "edge": "11.90.0.3", "lts": "11.86.0.24", "release": "11.88.0.13", "stable": "11.88.0.13" }, "metadata": { "command": "get_available_tiers", "reason": "Got tiers list", "result": 1, "version": 1 } }
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 } }