Child pages
  • Guide to Transfer and Restore API Functions - Pause and Restart the Transfer Session

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Excerpt

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.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@880
MultiExcerptNameTandRExcerpt
PageWithExcerptGuide to Transfer and Restore API Functions - Plan the Transfer Session

Pause an active transfer session

To pause an active transfer session, use the WHM API 1 pause_transfer_session function.

Select the tab below that corresponds to the method by which you wish to call the function:

Localtab Group


Localtab
titleJSON API

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@880
MultiExcerptNameJSONAPI
PageWithExcerptWHM API 1 Functions - pause_transfer_session


Localtab
titlePHP


Code Block
languagetext
linenumberstrue
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;



The function only returns metadata:

Expand
titleClick to view...

Multiexcerpt include
MultiExcerptNameOutputJSON
PageWithExcerptWHM API 1 Functions - pause_transfer_session

Restart the transfer session

To restart the transfer session, use the WHM API 1 start_transfer_session function.

Select the tab below that corresponds to the method by which you wish to call the function:

Localtab Group


Localtab
titleJSON API

Multiexcerpt include
MultiExcerptNameJSONAPI
PageWithExcerptWHM API 1 Functions - start_transfer_session


Localtab
titlePHP


Code Block
languagetext
linenumberstrue
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;