Transfers
Transfer Monitoring
Return transfer session's information
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 documentation.
get/retrieve_transfer_session_remote_analysis
Query parameters
transfer_session_idstring required
Example:exampleservercopya20140206192428NtyW
The transfer session's ID.
Response
HTTP Request was successful.
Example response
{
"data": {
"config": {
"shared_mysql_server": 1
},
"local": {
"dbs": {
"dbs": {
"MYSQL": {
"user_db1": {
"owner": "user"
},
"user_db2": {
"owner": "user"
}
},
"PGSQL": {
"user_db1": {
"owner": "user"
},
"user_db2": {
"owner": "user"
}
}
},
"users": {
"MYSQL": {
"user_user1": {
"owner": "user"
},
"user_user2": {
"owner": "user"
}
},
"PGSQL": {
"user_user1": {
"owner": "user"
},
"user_user2": {
"owner": "user"
}
}
}
},
"dedicated_ips": {
"192.168.1.2": "domain.tld"
},
"domains": {
"*": "nobody",
"domain.tld": "user"
},
"groups": {
"bin": 1,
"nobody": 1
},
"host": "hostname.domain.tld",
"major_version": "11.90",
"roundcube_dbtype": "sqlite",
"users": {
"nobody": 1,
"root": 1
},
"version": "11.90.0.6"
},
"modules": {
"Backups": {
"analysis": {
"Local Backups Version": "11.90.0.6",
"Remote Backups Version": "11.88.0.7"
},
"name": "Backups"
},
"MySQL": {
"analysis": {
"Local Type": "MySQL",
"Local Version": "5.7",
"Remote Type": "MariaDB",
"Remote Version": "10.3"
},
"name": "Database Server"
}
},
"remote": {
"cpversion": "11.64",
"dbs": {
"dbs": {
"MYSQL": {
"user_db1": {
"owner": "user"
},
"user_db2": {
"owner": "user"
}
},
"PGSQL": {
"user_db1": {
"owner": "user"
},
"user_db2": {
"owner": "user"
}
}
},
"users": {
"MYSQL": {
"user_user1": {
"owner": "user"
},
"user_user2": {
"owner": "user"
}
},
"PGSQL": {
"user_user1": {
"owner": "user"
},
"user_user2": {
"owner": "user"
}
}
}
},
"has_disk_used": 1,
"has_files_used": 1,
"has_owners": 1,
"has_package_extensions": 1,
"has_xfertool": 1,
"host": "192.168.1.1",
"hostname": "hostname.domain.tld",
"linked_nodes": [
{
"alias": "mailnode",
"enabled_services": [
"exim",
"imap"
],
"hostname": "remotemailnode.example.com",
"last_check": 1600126907,
"system_settings": {
"Mail": {
"globalspamassassin": 0
}
},
"tls_verified": 1,
"username": "root",
"version": "11.90.0.6",
"worker_capabilities": {
"Mail": {}
}
}
],
"major_version": "11.90",
"resellers": {
"resell2": 1,
"reseller": 1,
"root": 1
},
"roundcube_dbtype": "sqlite",
"server_type": "WHM1164",
"supports_live_transfers": 1,
"version": "11.90.0.6"
},
"transfer_session_id": "exampleservercopya20140206192428NtyW"
},
"metadata": {
"command": "retrieve_transfer_session_remote_analysis",
"reason": "OK",
"result": 1,
"version": 1
}
}