latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Domain Information

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.

get/convert_addon_initiate_conversion

Query parameters

domainstring domain required
Example:example.com

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

usernamestring username required
Example:username

The username for a specified account.

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.

movemysqldbstring

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.

movemysqluserstring

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.

pkgnamestring
Example:mycustompkg

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

Response

HTTP Request was successful.

dataobject

Example response

{
  "metadata": {
    "command": "convert_addon_initiate_conversion",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}