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


Description

This function lists all available transfer modules.

Note:

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


 JSON API


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

 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/available_transfer_modules?api.version=1
 Command Line
whmapi1 available_transfer_modules


Notes:

  • Unless otherwise noted, 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.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)


 {
  "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"
  }
}

 Output (XML)
<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>


Note:

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

   

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.

Note:

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

This function returns this value in the modules hash.

A positive integer.

Note:

The function lists transfer modules from lowest to highest priority.

6000