Page tree
Skip to end of metadata
Go to start of metadata


The start process begins the transfer session. Use the same process for both the root and transfer sessions.

In these examples, the following statements are true:

  • You have two servers: and
  • You logged in to the local server with the cpsess########## security token.
  • The example account owns, and you want to transfer it from the remote server to the local server.
  • The domain is 123,456,789 bytes.
  • You want to transfer the package1 package from the remote server to the local server.
  • The root password for the remote server is luggage12345  

Start the transfer session

After you add all of the transfer items to the transfer session, start the transfer session with the start_transfer_session function, as in the following examples:

include_once '../xmlapi.php';

$ip = getenv('REMOTE_HOST');
$root_user = getenv('REMOTE_USER');
$root_pass = getenv('REMOTE_PASSWORD');

$xmlapi = new xmlapi($ip , $root_user , $root_pass);

$settings = array('api.version'=>1, 'transfer_session_id'=>'remoteexamplecomnoroo20140501194105g7qG');
$_result = $xmlapi->xmlapi_query('start_transfer_session' , $settings);

print $_result;

The function returns the process ID that handles the transfer session:

 Click to view...

  "data": {
    "pid": "90210"
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "start_transfer_session"