---
title: "List virtual machines"
method: GET
path: "/v1/restore/virt"
tags: ["Restores (Virtual Machine)"]
---

# List virtual machines

`GET /v1/restore/virt`

## Query parameters

- `offset` integer
- `limit` integer
- `sort_by` 'created'
- `sort_asc` boolean
- `created_after` string, date-time
- `created_before` string, date-time

## Response `200`

OK

- object — Paginated response
  - `data` VirtualMachine[], required — List of virtual machines
    - `agent_id` string, required — ID of an agent
    - `cpu_count` integer, nullable, required — Number of CPUs
    - `created_at` string, date-time, required — Creation timestamp
    - `device_id` string, required — ID of a device
    - `disk_bus` 'sata' | 'virtio', required — Disk bus of the virtual machine
    - `expires_at` string, date-time — Expiration timestamp
    - `force_boot_menu` boolean — Whether to force the VM to boot to the menu
    - `ip_address` string — IP address
    - `mac_address` string, required — MAC address
    - `memory_in_mb` integer, nullable, required — Memory in MB
    - `network_model` 'hypervisor_default' | 'e1000' | 'rtl8139' | 'virtio', required — Network model of the virtual machine
    - `network_source` string — ID of an network
    - `network_type` 'network-none' | 'network-nat-shared' | 'network-nat-isolated' | 'network-hostonly' | 'bridge' | 'network-id' — Network type of the virtual machine. If this field is not present, the virtual machine does not have networking.
    - `purpose` 'test' | 'disaster', required — Purpose for creating the virtual machine or file restore. If this is set to disaster, Slide Support will recieve a notification that you are in a disaster. File restores not created by the slide box for file system verification will have this field set to disaster.
    - `rdp_endpoint` string — RDP endpoint
    - `snapshot_id` string, required — ID of a snapshot
    - `state` 'running' | 'stopped' | 'paused', required — State of the virtual machine
    - `virt_id` string, required — ID of a virtual machine
    - `vnc` VNC[], required — List of VNC connection info
      - `host` string — Host of the VNC server
      - `port` integer — Port of the VNC server
      - `type` 'local' | 'cloud', required — Type of the location
      - `websocket_uri` string — Websocket URI of the VNC server
    - `vnc_enabled` boolean, nullable, required — Whether VNC access is enabled
    - `vnc_password` string, password, required — VNC password
  - `pagination` Pagination, required
    - `next_offset` integer — Next offset to use for pagination. If this field is not present, that indicates there are no more items to fetch.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Internal server error

---

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