WHM API 1 Functions - 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

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

Return	Type	Description	Possible values	Example
`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`

Function information

API Version:

WHM API 1

Available in:

WHM 11.44+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Functions - restore_modules_summary — This function lists backup modules and their descriptions.
Page:

WHM API 1 Functions - abort_transfer_session — This function aborts an active transfer session.
Page:

WHM API 1 Functions - analyze_transfer_session_remote — This function checks the remote server's credentials, which a transfer session uses to connect.
Page:

WHM API 1 Functions - available_transfer_modules — This function lists all available transfer modules.
Page:

WHM API 1 Functions - create_remote_root_transfer_session — This function creates a transfer session as the root user.

Child pages