Interlaken
API referenceComputeVirtual machines

Virtual machines

27 operations.

List VMs

GET /api/v1/vms

Create a VM

POST /api/v1/vms

Get a VM

GET /api/v1/vms/{id}

Update a VM

PUT /api/v1/vms/{id}

Delete a VM

DELETE /api/v1/vms/{id}

Get a VM's activity feed (reconciler event log)

GET /api/v1/vms/{id}/activity

List databases attached to a VM

GET /api/v1/vms/{id}/attachments

Attach a managed database to a VM (composes its URL into a config var)

POST /api/v1/vms/{id}/attachments/database

Detach a managed database from a VM

DELETE /api/v1/vms/{id}/attachments/database/{database_id}

Get a VM's config vars (env vars)

GET /api/v1/vms/{id}/config-vars

Replace a VM's config vars (persists + best-effort live apply via agent)

PUT /api/v1/vms/{id}/config-vars

VM VNC console (WebSocket)

GET /api/v1/vms/{id}/console

Attach a disk to a VM

POST /api/v1/vms/{id}/disks

Detach a disk from a VM

DELETE /api/v1/vms/{id}/disks/{disk_id}

Force-stop a VM

POST /api/v1/vms/{id}/force-stop

Hard-reboot a VM

POST /api/v1/vms/{id}/hard-reboot

Mount an ISO into a VM's CD-ROM

POST /api/v1/vms/{id}/iso

Unmount the VM's CD-ROM ISO

DELETE /api/v1/vms/{id}/iso

Get VM metric history (chart series)

GET /api/v1/vms/{id}/metrics

Attach a NIC to a VM

POST /api/v1/vms/{id}/nics

Detach a NIC from a VM

DELETE /api/v1/vms/{id}/nics/{nic_id}

Reboot a VM

POST /api/v1/vms/{id}/reboot

Move a VM to another host

POST /api/v1/vms/{id}/reschedule

Resume a suspended VM from its memory snapshot

POST /api/v1/vms/{id}/resume

Start a VM

POST /api/v1/vms/{id}/start

Stop a VM

POST /api/v1/vms/{id}/stop

Suspend a VM to a memory snapshot (frees the host)

POST /api/v1/vms/{id}/suspend