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

Description

This function returns the status of the convert addon domain to account process for specified conversion jobs. For more detailed information about the conversion status of all jobs, use the convert_addon_fetch_conversion_details function.

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_get_conversion_status?api.version=1&job_id=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/convert_addon_get_conversion_status?api.version=1&job_id=1
 Command Line
whmapi1 convert_addon_get_conversion_status job_id=1


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)
{
   "data" : {
      "1" : {
         "source_acct" : "user1",
         "job_end_time" : 1462383658,
         "job_status" : "DONE",
         "job_id" : "1"
      }
   },
   "metadata" : {
      "reason" : "OK",
      "version" : 1,
      "result" : 1,
      "command" : "convert_addon_get_conversion_status"
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <command>convert_addon_get_conversion_status</command>
        <reason>OK</reason>
    </metadata>
    <data>
        <1>
            <source_acct>user1</source_acct>
            <job_end_time>1462383658</job_end_time>
            <job_status>DONE</job_status>
            <job_id>1</job_id>
        </1>
    </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.

Note:

To list entries for multiple conversion jobs , increment the parameter name. For example: job_id-0 , job_id-1 , and job_id-2 .

A valid positive integer.
1

Returns

Return

TypeDescriptionPossible valuesExample

job_id*

hash or hash of hashes

Note:

If you specify more than one job_id parameter, this return value displays as a hash of hashes.

A hash of the status information of the requested job.

Note:

The value's name is the identification number of the requested job.

This hash includes details of the conversion job's status. Each hash includes the source_acct, job_end_time, job_status, and job_id returns.

 

source_acct

string

The addon domain that you converted into an account.

The function returns this value in the job_id hash.

A valid addon domain.user1

job_end_time

integer

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

The function returns this value in the job_id hash.

A date in Unix time format.
1462383658

job_status

string

The status of the conversion process.

The function returns this value in the job_id hash.

  • DONE
  • IN PROGRESS
  • FAILED
DONE

job_id

string

The conversion's job identification number.

The function returns this value in the job_id hash.

A valid positive integer.

Note:

The system stores this numeric value as a string.

1