---
title: "Return transfer session's information"
method: GET
path: "/retrieve_transfer_session_remote_analysis"
tags: ["Transfers", "Transfer Monitoring"]
---

# Return transfer session's information

`GET /retrieve_transfer_session_remote_analysis`

This function analyzes a 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](https://go.cpanel.net/transferrestoreAPIguide) documentation.

## Query parameters

- `transfer_session_id` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `config` object — An object containing the transfer configuration options.
      - `shared_mysql_server` 0 | 1 — Whether the remote and target server share the same MySQL® server. * `1` - The remote and target server share the same MySQL server. * `0` - The remote and target server do **not** share the same MySQL server.
    - `items` object — An object containing items to transfer.
      - `accounts` unknown[] — The accounts to transfer.
        - unknown
      - `packages` unknown[] — The packages to transfer.
        - unknown
    - `local` object — An object containing the local server's information.
      - `available_ips` union[] — A list of the local server's available IP addresses.
        - union
          - string, ipv4
          - string, ipv6
      - `dbs` object — An object containing the local server's databases and users.
        - `dbs` object — An object containing the local server's databases.
          - `MYSQL` object — An object containing the local server's MySQL databases.
          - `PGSQL` object — An object containing the local server's PgSQL databases.
        - `users` object — An object containing the local server's database users.
          - `MYSQL` object — An object containing the local server's MySQL users.
          - `PGSQL` object — An object containing the local server's PgSQL databases users.
      - `dedicated_ips` object — A list of the local server's dedicated IP addresses.
      - `domains` unknown
      - `groups` object — An object containing the local server's account groups.
      - `host` string, domain — The local server's hostname.
      - `major_version` string — The local server's major version.
      - `roundcube_dbtype` 'sqlite' | 'mysql' — The database type Roundcube uses on the local server.
      - `users` object — An object containing the local server's account users.
      - `version` string, cPanel version — The local server's version of cPanel.
    - `modules` object — An list of objects containing the module infromation of both servers.
    - `options` object — An object containing transfer session options.
      - `skip_reseller_privs` 0 | 1 — Whether reseller privileges will be set to transfer by default. * `0` - Reseller privileges will **not** be set to transfer by default. * `1` - Reseller privileges will be set to transfer by default.
      - `unrestricted` 0 | 1 — Whether the transfer session will use [Restriced Restore](https://go.cpanel.net/insecurerestoreaccount). * `0` - Transfer session will use Restriced Restore. * `1` _ Transfer session will **not** use Restirced Restore.
    - `remote` object — An object containing the remote server's information.
      - `conflicts` object — Remote server data load error message.
      - `cpversion` string — Remote server internal version.
      - `dbs` object — An object containing the remote server's databases and users.
        - `dbs` object — An object containing the remote server's databases.
          - `MYSQL` object — An object containing the remote server's MySQL databases.
          - `PGSQL` object — An object containing the remote server's PgSQL databases.
        - `users` object — An object containing the remote server's database users.
          - `MYSQL` object — An object containing the remote server's MySQL users.
          - `PGSQL` object — An object containing the remote server's PgSQL databases users.
      - `has_disk_used` 0 | 1 — Whether the remote server can transmit disk usage information to the target server. * `1` - Remote server can transmit disk usage information. * `0` - Remote server **cannot** transmit disk usage information. **Note:** cPanel & WHM servers have this ability by default.
      - `has_files_used` 0 | 1 — Whether the remote server can transmit file usage information to the target server. * `1` - Remote server can transmit file usage information. * `0` - Remote server **cannot** transmit file usage information. **Note:** cPanel & WHM servers have this ability by default.
      - `has_owners` 0 | 1 — Whether the remote server can transmit owner information to the target server. * `1` — Remote server can transmit owner information. * `0` — Remote server **cannot** transfer owner information, and the transfer tool will assume that root owns all accounts.
      - `has_package_extensions` 0 | 1 — Whether the remote server has package extensions. * `1` - Remote server has package extensions. * `0` - Remote server does **not** have package extensions.
      - `has_xfertool` 0 | 1 — Whether the remote server has the transfer tool. * `1` - Remote server has the transfer tool. * `0` - Remote server does **not** have the transfer tool.
      - `host` string, ipv4 — The remote server's IP address.
      - `hostname` string, domain — The local server's hostname.
      - `linked_nodes` object[] — An array containing the remote server's linked cPanel server nodes, if any exist.
        - `alias` string — The remote server's linked cPanel server node alias.
        - `enabled_services` string[] — Enabled services on the linked node.
        - `hostname` string, domain — The remote server's linked cPanel server node hostname.
        - `last_check` integer — Last time linked node was checked.
        - `system_settings` object — An object containing server role system settings.
        - `tls_verified` 0 | 1 — Whether the connection to the server node is using TLS verification. * `0` - Server node connection is **note** using TLS verification. * `1` - Server node connection is using TLS verification.
        - `username` string — The username the server node link uses.
        - `version` string, cPanel version — The server node's software version number.
        - `worker_capabilities` object — An object containing a group of services required for the remote server's linked cPanel server node to perform a specific task.
      - `major_version` string — The remote server's major version.
      - `resellers` object — The remote servers reseller accounts that own one or more accounts. **Note:** This won't return a value if the `root` user is the only user that owns accounts.
      - `roundcube_dbtype` 'sqlite' | 'mysql' — The database type Roundcube uses on the remote server.
      - `server_type` string — The remote server's type. * An internal cPanel type ID dependent on cPanel version. * `Plesk` * `Ensim`
      - `supports_live_transfers` 0 | 1 — Whether the remote server supports the Live Transfers feature in WHM's Transfer Tool interface (WHM >> Home >> Transfers >> Transfer Tool). * `1` — Supported. * `0` — **Not** supported.
      - `version` string, cPanel version — The remote server's software version number.
    - `transfer_session_id` string — The transfer session's ID.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)