CPcpanel
Transfers
cPanel Account Transfer

Add module to transfer session

This function adds a transfer session to a queue. 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.

Important:

The module parameter determines which additional parameters to use with the function.

get/enqueue_transfer_item

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

OR
OR
OR
OR
OR

Example request

{
  "module": "AccountRemoteRoot",
  "size": 133698,
  "transfer_session_id": "vm5docscpanelcopya20140211211719FxjU",
  "customip": "192.168.0.1",
  "detected_remote_user": "user",
  "domain": "example.com",
  "ip": 1,
  "localuser": "localuser",
  "overwrite_sameowner_dbs": 1,
  "overwrite_sameowner_dbusers": 1,
  "overwrite_with_delete": 1,
  "replaceip": "all",
  "reseller": 1,
  "shared_mysql_server": 1,
  "skipaccount": 1,
  "skipacctdb": 1,
  "skipbwdata": 1,
  "skiphomedir": 1,
  "skipres": 1,
  "user": "user",
  "force": 1
}

Response

HTTP Request was successful.

Example response

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

Changes

No recorded changes to this operation across all 5 revisions of this API.