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 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 } }
Request
This function initiates the conversion process for an addon domain into a cPanel account.
Note:
For information about the data that the system migrates when you convert an addon domain, read our Addon Domain Conversion List documentation.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
Query
The addon domain to convert into an account's main domain.
Example: domain=example.com
Copy a MySQL® database from the source account to the new account with a new database name.
This parameter's format consists of copymysqldb, a hyphen, and the name of the existing database. For example, copymysqldb-olddatabase.
If you do not specify this parameter, the system does not copy any MySQL databases to the new account.
copymysqldb-*=copymysqldb-olddatabase1=newdatabase1 copymysqldb-olddatabase2=newdatabase2
copymysqldb-*=newdatabase
Move the specified MySQL database from the source account to the new account.
If you do not specify this parameter, the system does not move any MySQL databases to the new account.
Note:
To move multiple databases, increment the parameter name. For example, movemysqldb-1, movemysqldb-2, and movemysqldb-3.
movemysqldb=movemysqldb-1=exampledb1 movemysqldb-2=exampledb2 movemysqluser-3=exampledb3
movemysqldb=exampledb
Move the specified MySQL database user from the source account into the new MySQL database account.
If you do not specify this parameter, the system does not move any MySQL database users to the new account.
Note:
To move multiple database users, increment the parameter name. For example, movemysqluser-1, movemysqluser-2, and movemysqluser-3.
movemysqluser=movemysqluser-1=dbuser1 movemysqluser-2=dbuser2 movemysqluser-3=dbuser3
movemysqluser=dbuser1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/convert_addon_initiate_conversion
- A server running WHM.
https://whm-server.tld:2087/json-api/convert_addon_initiate_conversion
- 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_initiate_conversion?domain=example.com&username=username©mysqldb-*=string&movemysqldb=string&movemysqluser=string&pkgname=mycustompkg'Response
application/json
{ "data": {}, "metadata": { "command": "convert_addon_initiate_conversion", "reason": "OK", "result": 1, "version": 1 } }