Return transfer session's status

This function retrieves the state of a 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.

Authorizations:
query Parameters
transfer_session_id
required
string

The transfer session's ID.

Example: transfer_session_id=exampleservercopya20140206192428NtyW

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  get_transfer_session_state \
  transfer_session_id='exampleservercopya20140206192428NtyW'

Response samples

Content type
application/json
{
  • "data": {
    • "state_name": "TRANSFER_INPROGRESS"
    },
  • "metadata": {
    • "command": "get_transfer_session_state",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}