You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

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

Overview

In case of server issues, you can pause and restart an active transfer session. Use the same process for both the root and user transfer sessions.

In these examples, the following statements are true:

  • You have two servers: remote.example.com and hostname.example.com
  • You logged in to the local server with the cpsess########## security token.
  • The example account owns example.com, and you want to transfer it from the remote server to the local server.
  • The example.com 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  

Pause an active transfer session

    Page not found for multiexcerpt macro.
The page: SDK:WHM API 1 Functions - pause_transfer_session was not found. Please check/update the page name used in the 'multiexcerpt-include macro.

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);
$xmlapi->set_output('json');

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

print $_result;
 Click to view...

    Page not found for multiexcerpt macro.
The page: SDK:WHM API 1 Functions - pause_transfer_session was not found. Please check/update the page name used in the 'multiexcerpt-include macro.

Restart the transfer session

If you want to restart the transfer session, use the start_transfer_session function, as in the following examples:

    Page not found for multiexcerpt macro.
The page: SDK:WHM API 1 Functions - start_transfer_session was not found. Please check/update the page name used in the 'multiexcerpt-include macro.

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);
$xmlapi->set_output('json');

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

print $_result;

Additional documentation

There is no content with the specified labels

Error rendering macro 'contentbylabel'

parameters should not be empty

There is no content with the specified labels

Error rendering macro 'contentbylabel'

parameters should not be empty