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

Description

This function creates a transfer session with a non-root user to a remote server.

Important:

The source and target servers must be able to communicate over port 2087 to use this feature. They must also be able to communicate over the port that your servers use for SSH connections. For more information about the ports that cPanel & WHM uses, read our How to Configure Your Firewall for cPanel Services documentation.

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/create_remote_user_transfer_session?api.version=1&unrestricted_restore=1&host=hostname.example.com&password=12345luggage

 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/create_remote_user_transfer_session?api.version=1&unrestricted_restore=1&host=hostname.example.com&password=12345luggage
 Command Line
whmapi1 create_remote_user_transfer_session unrestricted_restore=1 host=hostname.example.com password=12345luggage


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": {
    "transfer_session_id": "vm5docscpanelnoroo201402251939519hmy"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "create_remote_user_transfer_session"
  }
}

 Output (XML)
<result>
    <data>
        <transfer_session_id>vm5docscpanelnoroo201402251939519hmy</transfer_session_id>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>create_remote_user_transfer_session</command>
    </metadata>
</result>


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
host
string

Required

The server hostname for the account.

A valid hostname on the server. hostname.example.com 
passwordstring

Required

The account's password.

A secure password.12345luggage
unrestricted_restore Boolean

Required

Whether to skip the Restricted Restore process.

Note:

We introduced this parameter in cPanel & WHM version 11.46.

  • 1 — Skip Restricted Restore.
  • 0 — Use Restricted Restore.

Note:

In cPanel & WHM version 11.46 and later, you must set this parameter to a value of 1.
1
permit_ftp_fallback Boolean

Note:

We deprecated this parameter in cPanel & WHM version 11.



Returns

ReturnTypeDescriptionPossible valuesExample
transfer_session_id
string

The transfer session's ID.

A valid string. vm5docscpanelnoroo201402251939519hmy