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/listlockedaccounts
- A server running WHM.
https://whm-server.tld:2087/json-api/listlockedaccounts
- 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/listlockedaccountsResponse
application/json
{ "data": { "account": [ … ] }, "metadata": { "command": "listlockedaccounts", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/listsuspended
- A server running WHM.
https://whm-server.tld:2087/json-api/listsuspended
- 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/listsuspendedResponse
application/json
{ "data": { "account": [ … ] }, "metadata": { "command": "listsuspended", "reason": "OK", "result": 1, "version": 1 } }
Query
Whether to allow only the root user to unsuspend the account.
1- Only therootuser can unsuspend the account.0- Therootuser or the account's owner can unsuspend the account.
Default 0
Enum01
Example: disallowun=1
Whether to skip suspension of the account's FTP accounts.
1- Do not suspend the FTP accounts.0- Suspend the FTP accounts.
Default 0
Enum01
Example: leave-ftp-accts-enabled=0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/suspendacct
- A server running WHM.
https://whm-server.tld:2087/json-api/suspendacct
- 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/suspendacct?user=username&disallowun=1&leave-ftp-accts-enabled=0&reason=Nonpayment'Response
application/json
{ "metadata": { "command": "suspendacct", "output": { … }, "reason": "OK", "result": 1, "version": 1 } }