Create remote server transfer session

This function creates a transfer session with a non-root user to a remote server.

Important:

  • The source and target servers must be able to communicate over port 2087 to use this feature.
  • The source and target servers must also be able to communicate over the port that your servers use for SSH connections.
  • For more information about the ports that cPanel & WHM uses, read our How to Configure Your Firewall for cPanel & WHM Services documentation.

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
host
required
string <domain>

The server hostname for the account.

Example: host=hostname.example.com
password
required
string

The account's password.

Example: password=12345luggage
unrestricted_restore
required
integer

Whether to skip the Restricted Restore process.

  • 1 - Skip Restricted Restore.
  • 0 - Use Restricted Restore.

Note:

You must set this parameter to a value of 1.

Value: 1
Example: unrestricted_restore=1

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  create_remote_user_transfer_session \
  host='hostname.example.com' \
  password='12345luggage' \
  unrestricted_restore='1'

Response samples

Content type
application/json
{
  • "data": {
    • "transfer_session_id": "vm5docscpanelnoroo201402251939519hmy"
    },
  • "metadata": {
    • "command": "create_remote_user_transfer_session",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}