# cPanel Account Transfer

Transfers / cPanel Account Transfer

## Stop transfer session

 - [GET /abort_transfer_session](https://api.docs.cpanel.net/specifications/whm.openapi/cpanel-account-transfer/abort_transfer_session.md): This function aborts an active transfer session.

## Create remote server transfer session as root user

 - [GET /create_remote_root_transfer_session](https://api.docs.cpanel.net/specifications/whm.openapi/cpanel-account-transfer/create_remote_root_transfer_session.md): This function creates a transfer session as the  user.



  For information about the ports that cPanel & WHM uses, read our How to Configure Your Firewall for cPanel Services documentation.



  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.

### Authentication
There are several methods that you can use to authenticate a transfer session with the remote server:

#### Authenticate as root
If you use SSH to authenticate as the  user, the remote server's SSH must accept  logins. For more information read OpenSSH's  documentation.

The following table displays the correct parameters and values for this authentication method:

| Parameter | Value |
|-|-|
|  |  |
|  | 's password |

You can also use an SSH public key to authenticate the  user. If the SSH public key is encrypted, include the SSH key's passphrase.

The following table displays the correct parameters and values for this authentication method:

| Parameter | Value if the SSH Key is not encrypted | Value if the SSH Key is encrypted |
|-|-|-|
|  |  |  |
|  | The  user's SSH key. | The  user's SSH key. |
|  |  | The  user's SSH key passphrase. |

#### Authenticate as a user
Many server administrators do not permit direct  logins via SSH on their servers.
* If the remote server forbids root logins, you  use another user and their password on the remote server, and then escalate to the  user. For more information read OpenSSH's  documentation.
Manage Wheel Group UsersWHM >> Home >> Security Center >> Manage Wheel Group Users*) to grant the user  access, then you will need to specify  and the  password.
* If the user has  access, you do  need the  password.

The following table displays the correct parameters and values for this authentication method:

| Parameter | Value if the user has sudo access | Value if the user has su access |
|-|-|-|
|  | The username. | The username. |
|  | The user's password. | The user's password. |
|  |  |  |
|  |  | The  user's password. |

You can also use an SSH public key instead of a password to authenticate that user. If the SSH public key is encrypted, include the SSH key's passphrase.

The following table displays the correct parameters and values for this authentication method:

| Parameter | sudo | su |
|-|-|-|
|  | The username. | The username. |
|  | The user's SSH key. | The user's SSH key. |
|  (If encrypted) | The user's SSH key passphrase. | The user's SSH key passphrase. |
|  |  |  |
|  |  | The  user's password. |

## Create remote server transfer session

 - [GET /create_remote_user_transfer_session](https://api.docs.cpanel.net/specifications/whm.openapi/cpanel-account-transfer/create_remote_user_transfer_session.md): This function creates a transfer session with a non-root user to a remote server.



* The source and target servers must be able to communicate over port  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.



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.

## Add module to transfer session

 - [GET /enqueue_transfer_item](https://api.docs.cpanel.net/specifications/whm.openapi/cpanel-account-transfer/enqueue_transfer_item.md): 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.



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

## Suspend active transfer session

 - [GET /pause_transfer_session](https://api.docs.cpanel.net/specifications/whm.openapi/cpanel-account-transfer/pause_transfer_session.md): This function pauses an active transfer session.



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.

## Start or restart transfer session

 - [GET /start_transfer_session](https://api.docs.cpanel.net/specifications/whm.openapi/cpanel-account-transfer/start_transfer_session.md): This function starts or restarts a transfer session.



  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.