Skip to main content
GET
/
get_vnc_url
/
{vm_id}
curl -X GET "http://CONTROL_PLANE_IP:PORT/get_vnc_url/vm-abc123"

{
  "status": "success",
  "vm_id": "vm-abc123",
  "vnc_url": "https://sandbox.outlier.ai/vm-8000/?path=vm-8000/websockify&resize=scale&reconnect=true&autoconnect=true",
  "vnc_port": 8000
}
Returns the VNC URL for connecting to a specific desktop environment. The VM must already be created and running.

​
Path Parameters

​
vm_id
string
required
VM identifier

​
Response

​
status
string
Result status (success)
​
vm_id
string
VM identifier
​
vnc_url
string
Full VNC connection URL
​
vnc_port
integer
VNC port number
curl -X GET "http://CONTROL_PLANE_IP:PORT/get_vnc_url/vm-abc123"

{
  "status": "success",
  "vm_id": "vm-abc123",
  "vnc_url": "https://sandbox.outlier.ai/vm-8000/?path=vm-8000/websockify&resize=scale&reconnect=true&autoconnect=true",
  "vnc_port": 8000
}