GetRemoteAccessFile

Get information to set up a remote connection to a VM. The information returned can be copied to an .rdp file, which can then be used to open an RDP session to the VM from the user’s PC.

Request URL

GET https://use.cloudshare.com/API/v2/Env/GetRemoteAccessFile?envId=<env>&vmId=<vm>&desktopWidth=<width>&desktopHeight=<height>&UserApiId=<id>&token=<token>&timestamp=<time>&HMAC=<signature>

Parameters

envId environment Id
Example: RE1F0J3DTSKA
vmId virtual machine Id
Example: ABV3UVVCHJ4B
desktopWidth
optional		 width of remote desktop (pixel)
Example: 640
desktopHeight
optional		 height of remote desktop (pixel)
Example: 480

Response example

 
{
    "data": {
        "clearTextPassword": "Se7MbRh59p", 
        "rdp": "username:s:administrator
        full address:s:10.113.10.240
        gatewayusagemethod:i:4
        password 51:b:<PASSWORD>
        audiomode:i:0
        redirectprinters:i:1
        redirectsmartcards:i:1
        redirectclipboard:i:1
        redirectposdevices:i:0
        redirectdirectx:i:1
        authentication level:i:2
        prompt for credentials:i:0
        negotiate security layer:i:1
        disable menu anims:i:1
        disable themes:i:0
        disable cursor setting:i:0
        connection type:i:2
        disable wallpaper:i:1
        allow font smoothing:i:0
        allow desktop composition:i:0
        videoplaybackmode:i:1
        compression:i:1
        screen mode id:i:2"
    }, 
    "remaining_api_calls": 100000, 
    "status_additional_data": null, 
    "status_code": "0x20000", 
    "status_text": "Success"
}

Note: the value PASSWORD for the returned password field should be replaced with the clearTextPassword value, encoded on the users’ PC. For more details, see – http://msdn.microsoft.com/en-us/library/windows/desktop/aa380261(v=vs.85).aspx