Child pages
  • WHM API 1 Functions - start_transfer_session

Versions Compared

Key

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

 

Description

Excerpt

This function starts or restarts a transfer session.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API

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

Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/start_transfer_session?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW
Expand
titleCommand Line
Code Block
languagebash
whmapi1 start_transfer_session transfer_session_id=exampleservercopya20140206192428NtyW

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)

Multiexcerpt
MultiExcerptNameOutputJSON
Code Block
languagetext
linenumberstrue
{
  "data": {
    "pid": "90210"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "start_transfer_session"
  }
}

Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <data>
        <pid>90210</pid>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>start_transfer_session</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

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