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 is used to save personalization data for a WHM user to a datastore on disk.
We call this system cPanel NVData.
cPanel NVData is a per-login configuration storage mechanism that you can use to maintain persistent user interface settings across multiple sessions.
This includes custom settings for your own themes and plugins.
This function is used to save personalzation data for WHM users only. If you want to save personalization data for cPanel users, use the UAPI function personalization_set.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/personalization_set
- A server running WHM.
https://whm-server.tld:2087/json-api/personalization_set
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/personalization_set \
-H 'Content-Type: application/json' \
-d '{
"api.version": 1,
"personalization": {
"coffee": "hot",
"milk": "cold"
},
"store": "beverages"
}'Response
application/json
{ "data": { "personalization": { … } }, "metadata": { "command": "personalization_set", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/removeacct
- A server running WHM.
https://whm-server.tld:2087/json-api/removeacct
- 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/removeacct?username=username&keepdns=0&user=username'Response
application/json
{ "metadata": { "command": "removeacct", "output": { … }, "reason": "example account removed", "result": 1, "version": 1 } }
Request
This function enables or disables Digest Authentication for an account. Windows Vista®, Windows® 7, and Windows® 8 requires that you enable Digest Authentication support in order to access your Web Disk over a clear text, unencrypted connection.
Note:
If the server has an SSL certificate that a recognized certificate authority signed and you can make an SSL connection over port 2078, you do not need to enable Digest Authentication.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_digest_auth
- A server running WHM.
https://whm-server.tld:2087/json-api/set_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/set_digest_auth?enabledigest=1&password=123456luggage&user=username&digestauth=1'Response
application/json
{ "metadata": { "command": "set_digest_auth", "reason": "Digest Authentication enabled.", "result": 1, "version": 1 } }