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 returns the details of a conversion from an addon domain to an account. Use WHM API 1's convert_addon_domain_to_account to start a conversion.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/convert_addon_fetch_conversion_details
- A server running WHM.
https://whm-server.tld:2087/json-api/convert_addon_fetch_conversion_details
- 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/convert_addon_fetch_conversion_details?job_id=2'Response
application/json
{ "data": { "domain": "cptestaddon175.tld", "job_end_time": 1462216653, "job_id": 2, "job_start_time": 1462465001, "job_status": "DONE", "source_acct": "cptest", "steps": [ … ], "target_acct": "user2" }, "metadata": { "command": "convert_addon_fetch_conversion_details", "reason": "OK", "result": 1, "version": 1 } }
Request
This function retrieves domain data for an addon domain.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/convert_addon_fetch_domain_details
- A server running WHM.
https://whm-server.tld:2087/json-api/convert_addon_fetch_domain_details
- 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/convert_addon_fetch_domain_details?domain=example.com'Response
application/json
{ "data": { "docroot": "/home/exampleparent/public_html/example.com", "has_dedicated_ip": 0, "has_ssl_cert_installed": 0, "ip": "192.0.2.0", "is_sni_supported": 0, "number_of_autoresponders": 0, "number_of_domain_forwarders": 1, "number_of_email_accounts": 2, "number_of_email_forwarders": 1, "owner": "username" }, "metadata": { "command": "convert_addon_fetch_domain_details", "reason": "OK", "result": 1, "version": 1 } }
Request
This function returns the status of the convert addon domain to account process for specified conversion jobs. For data about the conversion status of all jobs, use the WHM API 1 convert_addon_fetch_conversion_details function.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/convert_addon_get_conversion_status
- A server running WHM.
https://whm-server.tld:2087/json-api/convert_addon_get_conversion_status
- 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/convert_addon_get_conversion_status?job_id=1'Response
application/json
{ "data": { "1": { … } }, "metadata": { "command": "convert_addon_get_conversion_status", "reason": "OK", "result": 1, "version": 1 } }