Description

This function starts or restarts a transfer session.


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





https://hostname.example.com:2087/cpsess##########/json-api/start_transfer_session?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW





https://hostname.example.com:2087/cpsess##########/xml-api/start_transfer_session?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW




whmapi1 start_transfer_session transfer_session_id=exampleservercopya20140206192428NtyW




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





<result>
    <data>
        <pid>90210</pid>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>start_transfer_session</command>
    </metadata>
</result>



   

Parameters

ParameterTypeDescriptionPossible valuesExample
transfer_session_id
string

Required

The transfer session's ID.

A valid string. exampleservercopya20140206192428NtyW

Returns

ReturnTypeDescriptionPossible valuesExample
pid
integer

The transfer session's process ID.

A positive integer. 90210