API reference

Connect to screens, serial output and guest-agent files

Use tickets and bounded streams instead of exposing an unrestricted remote desktop or host filesystem.

Screen sessions

Machine screen endpoints describe displays and issue short-lived connection tickets. Tickets expire after 30 seconds, limiting reuse outside the intended session.

Serial console

Console endpoints provide serial output and input where the machine supports it. Log reads are bounded to the most recent 256 KB.

Guest-agent files

File and drag routes operate through a configured guest agent. A running guest, installed agent and guest permissions remain prerequisites; VMBook does not bypass the guest operating system.

Change stream

Stream and changes endpoints let clients update state without wasteful full polling. Reconnect by cursor and refresh authoritative state after a gap.