Child pages
  • WHM API 1 Functions - convert_addon_list_conversions

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function returns a list of addon domains converted into cPanel accounts.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_list_conversions?api.version=1



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/convert_addon_list_conversions?api.version=1



Expand
titleCommand Line


Code Block
whmapi1 convert_addon_list_conversions

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "metadata":{  
      "reason":"OK",
      "version":1,
      "command":"convert_addon_list_conversions",
      "result":1
   },
   "data":{  
      "conversions":[  
         {  
            "job_id":1,
            "status":"DONE",
            "domain":"cptestaddon175.tld",
            "target_acct":"user2",
            "source_acct":"cptest",
            "start_time":1462216639,
            "end_time":1462216653
         },
         {  
            "source_acct":"cptest",
            "target_acct":"user2",
            "end_time":1462218449,
            "start_time":1462218428,
            "job_id":2,
            "status":"DONE",
            "domain":"cptestaddon175.tld"
         },
         {  
            "job_id":3,
            "status":"DONE",
            "domain":"cptestaddon175.tld",
            "target_acct":"user2",
            "source_acct":"cptest",
            "end_time":1462218934,
            "start_time":1462218920
         },
         {  
            "status":"DONE",
            "job_id":4,
            "domain":"cptestaddon175.tld",
            "source_acct":"cptest",
            "target_acct":"user2",
            "end_time":1462218997,
            "start_time":1462218975
         }
      ]
   }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <command>convert_addon_list_conversions</command>
        <reason>OK</reason>
    </metadata>
    <data>
        <conversions>
            <job_id>1</job_id>
            <status>DONE</status>
            <domain>"cptestaddon175.tld</domain>
            <target_acct/>user2</target_acct>
            <source_acct>cptest</source_acct>
            <start_time>1462216639</start_time>
            <end_time>1462216653</end_time>
 
            <job_id>2</job_id>
            <status>DONE</status>
            <domain>"cptestaddon175.tld</domain>
            <target_acct/>user2</target_acct>
            <source_acct>cptest</source_acct>
            <start_time>1462218428</start_time>
            <end_time>1462218449</end_time>
 
            <job_id>3</job_id>
            <status>DONE</status>
            <domain>"cptestaddon175.tld</domain>
            <target_acct/>user2</target_acct>
            <source_acct>cptest</source_acct>
            <start_time>1462218920</start_time>
            <end_time>1462218934</end_time>
 
            <job_id>4</job_id>
            <status>DONE</status>
            <domain>"cptestaddon175.tld</domain>
            <target_acct/>user2</target_acct>
            <source_acct>cptest</source_acct>
            <start_time>1462218975</start_time>
            <end_time>1462218997</end_time>
        </conversions>
    </data>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

This function does not accept parameters.

Returns

Return

TypeDescriptionPossible valuesExample

conversions

hash

A hash of the conversion data.

 

This hash includes the job_id, status, target_acct, source_acct, start_time, and end_time returns.

 

job_id

integer

The conversion's job number.

The function returns this value in the conversions hash.

A valid positive integer.

1

status

string

The status of the conversion process.

The function returns this value in the conversions hash.

  • DONE
  • IN PROGRESS
  • FAILED
DONE

target_acct

string

The destination user account for the conversion.

The function returns this value in the conversions hash.

A valid cPanel user account.user2

source_acct

string

The cPanel account username that owned the domain at the time of conversion.

The function returns this value in the conversions hash.

A valid addon domain.cptest

start_time

integer

The time when the process started.

The function returns this value in the conversions hash.

A date in  Unix time  format.
1462216639

end_time

integer

The time when the process ended.

The function returns this value in the conversions hash.

A date in  Unix time  format.
1462216653