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 deletes a reseller and all of the reseller's cPanel accounts.
Warning:
- You cannot recover deleted accounts. Use this function with extreme caution.
- This function deletes the reseller account and all of the accounts that the reseller owns.
- To remove reseller privileges from an account but not delete the reseller's account or any accounts that the reseller owns, use the WHM API 1
unsetupresellerfunction.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/terminatereseller
- A server running WHM.
https://whm-server.tld:2087/json-api/terminatereseller
- 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/terminatereseller?terminatereseller=1&user=username'Response
application/json
{ "data": { "acct": [ … ] }, "metadata": { "command": "terminatereseller", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/unsetupreseller
- A server running WHM.
https://whm-server.tld:2087/json-api/unsetupreseller
- 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/unsetupreseller?user=username'Response
application/json
{ "metadata": { "command": "unsetupreseller", "reason": "OK", "result": 1, "version": 1 } }
Query
Whether to unsuspend only the reseller account.
1— The function only unsuspends the reseller account. The function will not unsuspend the accounts that the reseller account owns.0— The function unsuspends the reseller account and the accounts that it owns.
Default 0
Enum01
Example: reseller-only=0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/unsuspendreseller
- A server running WHM.
https://whm-server.tld:2087/json-api/unsuspendreseller
- 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/unsuspendreseller?user=username&reseller-only=0'Response
application/json
{ "metadata": { "command": "unsuspendreseller", "reason": "OK", "result": 1, "version": 1 } }