Skip to main content
GET
/
list_desktop_environments
curl -X GET "http://CONTROL_PLANE_IP:PORT/list_desktop_environments"

{
  "environments": [
    {
      "vm_id": "vm-abc123",
      "provider": "docker",
      "os_type": "Ubuntu",
      "status": "active",
      "start_time": 1234567890.123,
      "timeout": 3600,
      "age_seconds": 1200.5,
      "vnc_port": 8001,
      "last_open_connection": 1234568000.0,
      "time_since_last_connection": 90.123
    }
  ],
  "total": 1
}
Returns a list of all currently active desktop environments with their VM IDs, status, and metadata.

​
Response

​
environments
array
List of environment objects
​
total
integer
Total number of active environments

​
Environment Object Fields

​
vm_id
string
Unique VM identifier
​
provider
string
VM provider (e.g., docker)
​
os_type
string
Operating system
​
status
string
Environment status (active)
​
start_time
number
Unix timestamp of creation
​
timeout
integer
Session timeout in seconds
​
age_seconds
number
Time since creation
​
vnc_port
integer
VNC port number
curl -X GET "http://CONTROL_PLANE_IP:PORT/list_desktop_environments"

{
  "environments": [
    {
      "vm_id": "vm-abc123",
      "provider": "docker",
      "os_type": "Ubuntu",
      "status": "active",
      "start_time": 1234567890.123,
      "timeout": 3600,
      "age_seconds": 1200.5,
      "vnc_port": 8001,
      "last_open_connection": 1234568000.0,
      "time_since_last_connection": 90.123
    }
  ],
  "total": 1
}