Start additional domain conversion

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.

Authorizations:
query Parameters
domain
required
string <domain>

The addon domain to convert into an account's main domain.

Example: domain=example.com
username
required
string <username>

The username for a specified account.

Example: username=username
copymysqldb-*
string

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.

Examples:
copymysqldb-*=copymysqldb-olddatabase1=newdatabase1 copymysqldb-olddatabase2=newdatabase2
copymysqldb-*=newdatabase
movemysqldb
string

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.

Examples:
movemysqldb=movemysqldb-1=exampledb1 movemysqldb-2=exampledb2 movemysqluser-3=exampledb3
movemysqldb=exampledb
movemysqluser
string

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.

Examples:
movemysqluser=movemysqluser-1=dbuser1 movemysqluser-2=dbuser2 movemysqluser-3=dbuser3
movemysqluser=dbuser1
pkgname
string
Default: "default"

The hosting package that you want to assign to the new account.

Example: pkgname=mycustompkg

Responses

Response Schema: application/json
data
object
object

Request samples

whmapi1 --output=jsonpretty \
  convert_addon_initiate_conversion \
  username='username' \
  domain='example.com'

Response samples

Content type
application/json
{
  • "data": { },
  • "metadata": {
    • "command": "convert_addon_initiate_conversion",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}