All URIs are relative to http://localhost/api/v1
| Method | HTTP request | Description |
|---|---|---|
| boot_vm | PUT /vm.boot | Boot the previously created VM instance. |
| create_vm | PUT /vm.create | Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created. |
| delete_vm | PUT /vm.delete | Delete the cloud-hypervisor Virtual Machine (VM) instance. |
| pause_vm | PUT /vm.pause | Pause a previously booted VM instance. |
| power_button_vm | PUT /vm.power-button | Trigger a power button in the VM |
| reboot_vm | PUT /vm.reboot | Reboot the VM instance. |
| resume_vm | PUT /vm.resume | Resume a previously paused VM instance. |
| shutdown_vm | PUT /vm.shutdown | Shut the VM instance down. |
| shutdown_vmm | PUT /vmm.shutdown | Shuts the cloud-hypervisor VMM. |
| vm_add_device_put | PUT /vm.add-device | Add a new device to the VM |
| vm_add_disk_put | PUT /vm.add-disk | Add a new disk to the VM |
| vm_add_fs_put | PUT /vm.add-fs | Add a new virtio-fs device to the VM |
| vm_add_net_put | PUT /vm.add-net | Add a new network device to the VM |
| vm_add_pmem_put | PUT /vm.add-pmem | Add a new pmem device to the VM |
| vm_add_user_device_put | PUT /vm.add-user-device | Add a new userspace device to the VM |
| vm_add_vdpa_put | PUT /vm.add-vdpa | Add a new vDPA device to the VM |
| vm_add_vsock_put | PUT /vm.add-vsock | Add a new vsock device to the VM |
| vm_coredump_put | PUT /vm.coredump | Takes a VM coredump. |
| vm_counters_get | GET /vm.counters | Get counters from the VM |
| vm_info_get | GET /vm.info | Returns general information about the cloud-hypervisor Virtual Machine (VM) instance. |
| vm_receive_migration_put | PUT /vm.receive-migration | Receive a VM migration from URL |
| vm_remove_device_put | PUT /vm.remove-device | Remove a device from the VM |
| vm_resize_put | PUT /vm.resize | Resize the VM |
| vm_resize_zone_put | PUT /vm.resize-zone | Resize a memory zone |
| vm_restore_put | PUT /vm.restore | Restore a VM from a snapshot. |
| vm_send_migration_put | PUT /vm.send-migration | Send a VM migration to URL |
| vm_snapshot_put | PUT /vm.snapshot | Returns a VM snapshot. |
| vmm_ping_get | GET /vmm.ping | Ping the VMM to check for API server availability |
boot_vm() Boot the previously created VM instance.
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
create_vm(vm_config) Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| vm_config | VmConfig | The VM configuration | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_vm() Delete the cloud-hypervisor Virtual Machine (VM) instance.
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pause_vm() Pause a previously booted VM instance.
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
power_button_vm() Trigger a power button in the VM
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
reboot_vm() Reboot the VM instance.
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
resume_vm() Resume a previously paused VM instance.
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
shutdown_vm() Shut the VM instance down.
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
shutdown_vmm() Shuts the cloud-hypervisor VMM.
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::PciDeviceInfo vm_add_device_put(device_config) Add a new device to the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| device_config | DeviceConfig | The path of the new device | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::PciDeviceInfo vm_add_disk_put(disk_config) Add a new disk to the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| disk_config | DiskConfig | The details of the new disk | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::PciDeviceInfo vm_add_fs_put(fs_config) Add a new virtio-fs device to the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| fs_config | FsConfig | The details of the new virtio-fs | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::PciDeviceInfo vm_add_net_put(net_config) Add a new network device to the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| net_config | NetConfig | The details of the new network device | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::PciDeviceInfo vm_add_pmem_put(pmem_config) Add a new pmem device to the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| pmem_config | PmemConfig | The details of the new pmem device | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::PciDeviceInfo vm_add_user_device_put(vm_add_user_device) Add a new userspace device to the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| vm_add_user_device | VmAddUserDevice | The path of the new device | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::PciDeviceInfo vm_add_vdpa_put(vdpa_config) Add a new vDPA device to the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| vdpa_config | VdpaConfig | The details of the new vDPA device | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::PciDeviceInfo vm_add_vsock_put(vsock_config) Add a new vsock device to the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| vsock_config | VsockConfig | The details of the new vsock device | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
vm_coredump_put(vm_coredump_data) Takes a VM coredump.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| vm_coredump_data | VmCoredumpData | The coredump configuration | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
::std::collections::HashMap<String, ::std::collections::HashMap<String, i64>> vm_counters_get() Get counters from the VM
This endpoint does not need any parameter.
::std::collections::HashMap<String, ::std::collections::HashMap<String, i64>>
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::VmInfo vm_info_get() Returns general information about the cloud-hypervisor Virtual Machine (VM) instance.
This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
vm_receive_migration_put(receive_migration_data) Receive a VM migration from URL
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| receive_migration_data | ReceiveMigrationData | The URL for the reception of migration state | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
vm_remove_device_put(vm_remove_device) Remove a device from the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| vm_remove_device | VmRemoveDevice | The identifier of the device | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
vm_resize_put(vm_resize) Resize the VM
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| vm_resize | VmResize | The target size for the VM | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
vm_resize_zone_put(vm_resize_zone) Resize a memory zone
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| vm_resize_zone | VmResizeZone | The target size for the memory zone | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
vm_restore_put(restore_config) Restore a VM from a snapshot.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| restore_config | RestoreConfig | The restore configuration | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
vm_send_migration_put(send_migration_data) Send a VM migration to URL
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| send_migration_data | SendMigrationData | The URL for sending the migration state | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
vm_snapshot_put(vm_snapshot_config) Returns a VM snapshot.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| vm_snapshot_config | VmSnapshotConfig | The snapshot configuration | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::VmmPingResponse vmm_ping_get() Ping the VMM to check for API server availability
This endpoint does not need any parameter.
crate::models::VmmPingResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]