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.

SecurityBasicAuth

Request

query Parameters

transfer_session_id

required

string

The transfer session's ID.

Example: transfer_session_id=exampleservercopya20140206192428NtyW

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/get_transfer_session_state

Request samples

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

Response samples

application/json

{"data": {"state_name": "TRANSFER_INPROGRESS"
},
"metadata": {"command": "get_transfer_session_state",
"reason": "OK",
"result": 1,
"version": 1
}
}