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 retrieves a transfer module's key structure.
Note:
For more information about how this function works with other functions in the transfer and restore process, read our Guide to Transfer and Restore API Functions documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/transfer_module_schema
- A server running WHM.
https://whm-server.tld:2087/json-api/transfer_module_schema
- 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/transfer_module_schema?module=AccountRemoteRoot'Response
application/json
{ "data": { "schema": { … } }, "metadata": { "command": "transfer_module_schema", "reason": "OK", "result": 1, "version": 1 } }
Request
This function validates a system user for use on the target server.
Note:
For more information about how this function works with other functions in the transfer and restore process, read our Guide to Transfer and Restore API Functions documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/validate_system_user
- A server running WHM.
https://whm-server.tld:2087/json-api/validate_system_user
- 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/validate_system_user?user=username'Response
application/json
{ "data": { "exists": 1, "reserved": 1, "valid_for_new": 1, "valid_for_transfer": 1 }, "metadata": { "command": "validate_system_user", "reason": "OK", "result": 1, "version": 1 } }