Suspend active transfer session

This function pauses 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.

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

get/pause_transfer_session

Request samples

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

Response samples

application/json

{"metadata": {"command": "pause_transfer_session",
"reason": "OK.",
"result": 1,
"version": 1
}
}