Child pages
  • WHM API 1 Functions - convert_addon_fetch_conversion_details
Skip to end of metadata
Go to start of metadata

Description

This function returns the details of the convert addon domain to account process.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_fetch_conversion_details?api.version=1&job_id=2
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/convert_addon_fetch_conversion_details?api.version=1&job_id=2
 Command Line
whmapi1 convert_addon_fetch_conversion_details job_id=2


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "metadata":{  
      "result":1,
      "reason":"OK",
      "command":"convert_addon_fetch_conversion_details",
      "version":1
   },
   "data":{  
      "steps":[  
         {  
            "end_time":1462465001,
            "warnings":null,
            "step_name":"Saving email forwarder data",
            "start_time":1462465001,
            "status":"DONE"
         },
         {  
            "start_time":1462465001,
            "status":"DONE",
            "end_time":1462465001,
            "step_name":"Saving custom DNS records",
            "warnings":null
         },
         {  
            "end_time":1462465001,
            "step_name":"Saving installed SSL Certificate",
            "warnings":null,
            "start_time":1462465001,
            "status":"DONE"
         },
         {  
            "step_name":"Saving EasyApache 4 configuration",
            "end_time":1462465001,
            "warnings":null,
            "start_time":1462465001,
            "status":"DONE"
         },
         {  
            "warnings":null,
            "end_time":1462465009,
            "step_name":"Removing Addon Domain",
            "start_time":1462465001,
            "status":"DONE"
         },
         {  
            "start_time":1462465009,
            "status":"DONE",
            "end_time":1462465014,
            "warnings":null,
            "step_name":"Creating new cPanel account"
         },
         {  
            "status":"DONE",
            "start_time":1462465014,
            "step_name":"Restoring custom DNS records",
            "end_time":1462465015,
            "warnings":null
         },
         {  
            "warnings":null,
            "end_time":1462465016,
            "step_name":"Copying Custom VirtualHost Includes",
            "start_time":1462465015,
            "status":"DONE"
         },
         {  
            "start_time":1462465016,
            "status":"DONE",
            "warnings":"/usr/bin/gtar: ./shadow: Cannot open: Permission denied\\n/usr/bin/gtar: Exiting with failure status due to previous errors",
            "end_time":1462465016,
            "step_name":"Copying document root content"
         },
         {  
            "end_time":1462465016,
            "warnings":null,
            "step_name":"Setting the proper permissions on document root",
            "status":"DONE",
            "start_time":1462465016
         },
         {  
            "status":"DONE",
            "start_time":1462465016,
            "end_time":1462465017,
            "warnings":null,
            "step_name":"Copying email accounts"
         },
         {  
            "status":"DONE",
            "start_time":1462465017,
            "end_time":1462465017,
            "step_name":"Restoring email forwarders",
            "warnings":null
         },
         {  
            "status":"DONE",
            "start_time":1462465017,
            "end_time":1462465017,
            "step_name":"Copying Autoresponders",
            "warnings":null
         },
         {  
            "step_name":"Copying webmail data",
            "end_time":1462465017,
            "warnings":null,
            "status":"DONE",
            "start_time":1462465017
         },
         {  
            "end_time":1462465017,
            "step_name":"Restoring installed SSL Certificate",
            "warnings":null,
            "status":"DONE",
            "start_time":1462465017
         },
         {  
            "status":"DONE",
            "start_time":1462465017,
            "end_time":1462465017,
            "warnings":null,
            "step_name":"Restoring EasyApache 4 configuration"
         }
      ],
      "target_acct":"user2",
      "domain":"cptestaddon175.tld",
      "job_start_time":1462465001,
      "job_id":2,
      "source_acct":"cptest",
      "job_end_time":1462465017
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <command>convert_addon_fetch_conversion_details</command>
        <reason>OK</reason>
    </metadata>
    <data>
        <steps>
            <step_name>Saving email forwarder data</step_name>
            <status>DONE</status>
            <warnings>null</warnings>
            <start_time>1462465001</start_time>
            <end_time>1462465001</end_time>
 
            <end_time>1462465001</end_time>
            <warnings>null</warnings>
            <step_name>Saving custom DNS records</step_name>
            <start_time>1462465001</start_time>
            <status>DONE</status>
 
            <end_time>1462465001</end_time>
            <warnings>null</warnings>
            <step_name>Saving installed SSL Certificate</step_name>
            <start_time>1462465001</start_time>
            <status>DONE</status>
 
            <end_time>1462465001</end_time>
            <warnings>null</warnings>
            <step_name>Saving installed SSL Certificate</step_name>
            <start_time>1462465001</start_time>
            <status>DONE</status>
 
            <end_time>1462465001</end_time>
            <warnings>null</warnings>
            <step_name>Saving EasyApache 4 configuration</step_name>
            <start_time>1462465001</start_time>
            <status>DONE</status>
 
            <end_time>1462465009</end_time>
            <warnings>null</warnings>
            <step_name>Removing Addon Domain</step_name>
            <start_time>1462465001</start_time>
            <status>DONE</status>
 
            <end_time>1462465014</end_time>
            <warnings>null</warnings>
            <step_name>Creating new cPanel account</step_name>
            <start_time>1462465009</start_time>
            <status>DONE</status>
 
            <end_time>1462465015</end_time>
            <warnings>null</warnings>
            <step_name>Restoring custom DNS records</step_name>
            <start_time>1462465014</start_time>
            <status>DONE</status>
 
            <end_time>1462465016</end_time>
            <warnings>null</warnings>
            <step_name>Copying Custom VirtalHost Includes</step_name>
            <start_time>1462465015</start_time>
            <status>DONE</status>
 
            <end_time>1462465016</end_time>
            <warnings>/usr/bin/gtar: ./shadow: Cannot open: Permission denied\\n/usr/bin/gtar:</warnings>
            <step_name>Copying document root content</step_name>
            <start_time>1462465016</start_time>
            <status>DONE</status>
 
            <end_time>1462465016</end_time>
            <warnings>null</warnings>
            <step_name>Setting the proper permissions on document root</step_name>
            <start_time>1462465016</start_time>
            <status>DONE</status>
 
            <end_time>1462465017</end_time>
            <warnings>null</warnings>
            <step_name>Copying email accounts</step_name>
            <start_time>1462465016</start_time>
            <status>DONE</status>
 
            <end_time>1462465017</end_time>
            <warnings>null</warnings>
            <step_name>Restoring email forwarders</step_name>
            <start_time>1462465017</start_time>
            <status>DONE</status>
 
            <end_time>1462465017</end_time>
            <warnings>null</warnings>
            <step_name>Copying Autoresponders</step_name>
            <start_time>1462465017</start_time>
            <status>DONE</status>
 
            <end_time>1462465017</end_time>
            <warnings>null</warnings>
            <step_name>Copying webmail data</step_name>
            <start_time>1462465017</start_time>
            <status>DONE</status>
 
            <end_time>1462465001</end_time>
            <warnings>null</warnings>
            <step_name>Saving installed SSL Certificate</step_name>
            <start_time>1462465001</start_time>
            <status>DONE</status>
 
            <end_time>1462465017</end_time>
            <warnings>null</warnings>
            <step_name>Restoring installed SSL Certificate</step_name>
            <start_time>1462465017</start_time>
            <status>DONE</status>
 
            <end_time>1462465017</end_time>
            <warnings>null</warnings>
            <step_name>Restoring EasyApache 4 configureation</step_name>
            <start_time>1462465017</start_time>
            <status>DONE</status>
        </steps>
        <target_acct/>user2</target_acct>
        <domain>"cptestaddon175.tld</domain>
        <job_start_time>1462465001</start_time>
        <job_id>2</job_id>
        <source_acct>cptest</source_acct>
        <job_end_time>1462465017</end_time>
    </data>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
job_idinteger

Required.

The conversion's job identification number.

A valid positive integer.
2

Returns

Return

TypeDescriptionPossible valuesExample

steps

array of hashes

An array of hashes of the ordered list of steps taken by the conversion process.

This array includes hashes of the conversion process steps. Each hash includes the step_name, status, warnings, start_time, and end_time returns.

 

step_name

string

The step of the conversion process.

The function returns this value in the steps array.

A step of the convert addon domain to account process.

Saving email forwarder data

status

string

The status of the conversion process.

The function returns this value in the steps array.

  • DONE
  • IN PROGRESS
  • FAILED
DONE

start_time

integer

The time when the process started.

The function returns this value in the steps array.

A date in  Unix time  format.
1462465001

end_time

integer

The time when the process ended.

The function returns this value in the steps array.

A date in  Unix time  format.
1462465001

warnings

string

The warning message for the step.

The function returns this value in the steps array.

A comment that describes a potential problem.
/usr/bin/gtar: ./shadow: Cannot open: Permission denied

job_id

integer

The conversion's job identification number.

A valid positive integer.

2

target_acct

string

The destination user account for the conversion.

A valid cPanel user account.user2

source_acct

string

The addon domain that you converted into an account.

A valid addon domain.cptest

job_start_time

integer

The time when the convert addon to domain process started.

A date in Unix time format.
1462465001

job_end_time

integer

The time when the convert addon domain to account process ended.

 

A date in Unix time format.
1462216653
domainstringThe addon domain you converted into a cPanel account.A valid addon domain.cptestaddon175.tld