Description

This function aborts an active transfer session.

Examples 


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

{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "abort_transfer_session"
  }
}
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>abort_transfer_session</command>
    </metadata>
</result>

   

Parameters

ParameterTypeDescriptionPossible valuesExample
transfer_session_id
string

Required

The transfer session's ID.

A valid string.exampleservercopya20140206192428NtyW

Returns

This function only returns metadata.