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

 

Description

This function starts or restarts a transfer session.

Examples 


 JSON API

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

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


Notes:

  • 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": {
    "pid": "90210"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "start_transfer_session"
  }
}

 Output (XML)
<result>
    <data>
        <pid>90210</pid>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>start_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
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