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

Description

This function retrieves the state of an active transfer session.

Note:

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


 JSON API


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

 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_transfer_session_state?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW
 Command Line
whmapi1 get_transfer_session_state 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": {
    "state_name": "TRANSFER_INPROGRESS"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "get_transfer_session_state"
  }
}

 Output (XML)
<result>
   <data>
      <state_name>TRANSFER_INPROGRESS</state_name>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>get_transfer_session_state</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
transfer_session_id
string

The transfer session's state.

  • TRANSFER_PENDING
  • TRANSFER_INPROGRESS
  • RESTORE_PENDING
  • RESTORE_INPROGRESS
  • RUNNING
  • PAUSED
  • PENDING
  • COMPLETED
  • ABORTED
  • FAILED

TRANSFER_INPROGRESS