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/get_upgrade_opportunities
- A server running WHM.
https://whm-server.tld:2087/json-api/get_upgrade_opportunities
- 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_upgrade_opportunities?disk_threshold_blocks=8388608&nearness_fraction=0.6'Response
application/json
{ "data": { "upgrade_opportunities": { … } }, "metadata": { "command": "get_upgrade_opportunities", "reason": "OK", "result": 1, "version": 1 } }
Request
This function checks whether Digest Authentication is enabled for a cPanel user. Windows® Vista, Windows® 7, and Windows® 8 require Digest Authentication support in order to access Web Disk over an unencrypted connection.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/has_digest_auth
- A server running WHM.
https://whm-server.tld:2087/json-api/has_digest_auth
- 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/has_digest_auth?user=username'Response
application/json
{ "data": { "digestauth": 1 }, "metadata": { "command": "has_digest_auth", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/has_mycnf_for_cpuser
- A server running WHM.
https://whm-server.tld:2087/json-api/has_mycnf_for_cpuser
- 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/has_mycnf_for_cpuser?user=user'Response
application/json
{ "data": { "has_mycnf_for_cpuser": 1 }, "metadata": { "command": "has_mycnf_for_cpuser", "reason": "OK", "result": 1, "version": 1 } }