Do not forget to update Guide to Transfer and Restore API Functions

Description

This function lists all available transfer modules.


For more information about how this function works with other functions in the transfer and restore process, read our Guide to Transfer and Restore API Functions documentation.


Examples





https://hostname.example.com:2087/cpsess##########/json-api/available_transfer_modules?api.version=1





https://hostname.example.com:2087/cpsess##########/xml-api/available_transfer_modules?api.version=1




whmapi1 available_transfer_modules




 {
  "data": {
    "modules": {
      "LegacyAccountBackup": "6000",
      "FeatureListRemoteRoot": "1000",
      "PackageRemoteRoot": "2000",
      "AccountLocal": "5000",
      "AccountRemoteRoot": "3000",
      "AccountRemoteUser": "4000"
    }
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "available_transfer_modules"
  }
}





<result>
    <data>
        <modules>
            <LegacyAccountBackup>6000</LegacyAccountBackup>
            <FeatureListRemoteRoot>1000</FeatureListRemoteRoot>
            <PackageRemoteRoot>2000</PackageRemoteRoot>
            <AccountLocal>5000</AccountLocal>
            <AccountRemoteRoot>3000</AccountRemoteRoot>
            <AccountRemoteUser>4000</AccountRemoteUser>
        </modules>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>available_transfer_modules</command>
    </metadata>
</result>



   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
modules
hash

A hash of transfer module information.

A hash that includes the transfer module return. 

transfer module

string

The priority of the transfer module.

The return's name is the transfer module's name.

This function returns this value in the modules hash.

A positive integer.

The function lists transfer modules from lowest to highest priority.


6000