Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Restores (Virtual Machine)

Update virtual machine

patch/v1/restore/virt/{virt_id}

Path parameters

virt_idstring required

ID of a virtual machine

Example:virt_0123456789ab

Request body

cpu_countinteger nullable

Number of CPUs

expires_atstring date-time

Expiration timestamp

force_boot_menuboolean

Whether to force the VM to boot to the menu

memory_in_mbinteger nullable

Memory in MB

network_model'hypervisor_default' | 'e1000' | 'rtl8139' | 'virtio'

Network model of the virtual machine

network_sourcestring

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'

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.

state'running' | 'stopped' | 'paused'

State of the virtual machine

vnc_enabledboolean nullable

Whether VNC access is enabled

Example request

{
  "cpu_count": 2,
  "expires_at": "2024-08-23T01:25:08Z",
  "memory_in_mb": 4096,
  "network_model": "virtio",
  "network_source": "net_012345",
  "network_type": "bridge",
  "purpose": "disaster",
  "state": "running"
}

Response

Accepted

agent_idstring required

ID of an agent

cpu_countinteger nullable required

Number of CPUs

created_atstring date-time required

Creation timestamp

device_idstring required

ID of a device

disk_bus'sata' | 'virtio' required

Disk bus of the virtual machine

expires_atstring date-time

Expiration timestamp

force_boot_menuboolean

Whether to force the VM to boot to the menu

ip_addressstring

IP address

mac_addressstring required

MAC address

memory_in_mbinteger nullable required

Memory in MB

network_model'hypervisor_default' | 'e1000' | 'rtl8139' | 'virtio' required

Network model of the virtual machine

network_sourcestring

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_endpointstring

RDP endpoint

snapshot_idstring required

ID of a snapshot

state'running' | 'stopped' | 'paused' required

State of the virtual machine

virt_idstring required

ID of a virtual machine

vnc_enabledboolean nullable required

Whether VNC access is enabled

vnc_passwordstring password required

VNC password

Example response

{
  "agent_id": "a_0123456789ab",
  "cpu_count": 2,
  "created_at": "2024-08-23T01:25:08Z",
  "device_id": "d_0123456789ab",
  "disk_bus": "virtio",
  "expires_at": "2024-08-23T01:25:08Z",
  "memory_in_mb": 4096,
  "network_model": "virtio",
  "network_source": "net_012345",
  "network_type": "bridge",
  "purpose": "disaster",
  "snapshot_id": "s_0123456789ab",
  "state": "running",
  "virt_id": "virt_0123456789ab",
  "vnc": [
    {
      "host": "192.168.1.53",
      "port": 12345,
      "websocket_uri": "wss://example.com"
    }
  ]
}