This function creates a transfer session with a non-root user to a remote server.
Important:
2087
to use this feature.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.
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.
Note: You must set this parameter to a value of 1. Example: unrestricted_restore=1 |
object | |
object |
whmapi1 --output=jsonpretty \ create_remote_user_transfer_session \ host='hostname.example.com' \ password='12345luggage' \ unrestricted_restore='1'
{- "data": {
- "transfer_session_id": "vm5docscpanelnoroo201402251939519hmy"
}, - "metadata": {
- "command": "create_remote_user_transfer_session",
- "reason": "OK",
- "result": 1,
- "version": 1
}
}