Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function initiates the conversion process for an addon domain.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_initiate_conversionapi.version=1&domain=example&username=user1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/convert_addon_initiate_conversionapi.version=1&domain=example.tld&username=user1
 Command Line
whmapi1 convert_addon_initiate_conversion domain=example.tld user=user1

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
   "metadata" : {
      "version" : 1,
      "reason" : "OK",
      "result" : 1,
      "command" : "convert_addon_initiate_conversion"
   },
   "data" : {}
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <command>convert_addon_initiate_conversion</command>
        <reason>OK</reason>
    </metadata>
    <data></data>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
usernamestring

Required

The username for a specified account.

A valid cPanel user account.user1
domainstring

Required

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

A valid addon domain.example.tld

Returns

This function only returns metadata.