Skip to content

Virtual machines ​

GET /api/agent/servers/{id}/vm-authorization ​

Fresh hold and active-lease decision before guest boot

  • Access: Node agent credential
  • Path parameters: id

GET /api/agent/vm-consoles ​

Authorized pending binary console relays for this node

  • Access: Node agent credential

GET /api/servers/{id}/vm ​

VM hardware, disks, network and snapshots

  • Access: Signed-in user (browser session)
  • Path parameters: id

POST /api/servers/{id}/vm/console-ticket ​

Single-use browser VNC or serial connection ticket

  • Access: Signed-in user (browser session)
  • Path parameters: id

POST /api/servers/{id}/vm/disks ​

Add or grow stopped VM disks

  • Access: Signed-in user (browser session)
  • Path parameters: id

POST /api/servers/{id}/vm/installation ​

Attach approved media or reinstall a stopped VM

  • Access: Signed-in user (browser session)
  • Path parameters: id

POST /api/servers/{id}/vm/migrate ​

Back up and move a stopped VM; hosts must explicitly confirm pool changes

  • Access: Signed-in user (browser session)
  • Path parameters: id
  • Body: nodeId:uuid, networkId:uuid, confirmNetworkChange?:boolean

GET /api/servers/{id}/vm/migration-targets ​

Compatible host-approved offline migration destinations

  • Access: Signed-in user (browser session)
  • Path parameters: id

POST /api/servers/{id}/vm/network ​

Set NAT rules for allocated host ports

  • Access: Signed-in user (browser session)
  • Path parameters: id

POST /api/servers/{id}/vm/resources ​

Change stopped VM vCPUs and RAM within effective limits

  • Access: Signed-in user (browser session)
  • Path parameters: id
  • Body: vcpus:number, memoryMb:number

POST /api/servers/{id}/vm/snapshots ​

Copy a stopped VM snapshot

  • Access: Signed-in user (browser session)
  • Path parameters: id

DELETE /api/servers/{id}/vm/snapshots/{snapshot} ​

Delete a local VM snapshot

  • Access: Signed-in user (browser session)
  • Path parameters: id, snapshot

POST /api/servers/{id}/vm/snapshots/{snapshot}/restore ​

Restore disks, firmware and TPM from a snapshot

  • Access: Signed-in user (browser session)
  • Path parameters: id, snapshot

GET /api/virtualization/catalogue ​

Approved VM media, hardware profiles and networks

  • Access: Signed-in user (browser session)

POST /api/virtualization/media ​

Register checksum-verified HTTPS media

  • Access: Administrator

PATCH /api/virtualization/media/{id} ​

Enable or disable media for new installations

  • Access: Administrator
  • Path parameters: id
  • Body: enabled:boolean

POST /api/virtualization/networks ​

Register a configured network and guest IP pool

  • Access: Administrator

PATCH /api/virtualization/networks/{id} ​

Enable or disable a configured guest pool

  • Access: Administrator
  • Path parameters: id
  • Body: enabled:boolean

POST /api/virtualization/profiles ​

Create an immutable hardware profile

  • Access: Administrator

PATCH /api/virtualization/profiles/{id} ​

Enable or disable an approved hardware profile

  • Access: Administrator
  • Path parameters: id
  • Body: enabled:boolean

Released under the AGPL-3.0-only license.