API reference

Keep the API available without the desktop window

Run VMBook as a background service, provision browser users locally and understand session boundaries.

Service mode

vmbook --service on
vmbook --service status
vmbook --service off

The keeper serves the API while the desktop window is closed. Only one VMBook service owns the computer ports at a time.

Platform behavior

Linux uses a systemd user unit and may need linger for startup before login. Windows starts the service when its VMBook user signs in because the Windows hypervisor serves signed-in users.

Provision web users locally

vmbook --user add operator
vmbook --user password operator
vmbook --user remove operator
vmbook --user list

Users cannot add themselves through the web page. Password hashes use SHA-512-crypt with 200,000 rounds and the user file is restricted to the service account.

Session security

POST /v1/session signs in, GET reports the session and DELETE signs out. Cookies are HttpOnly, Secure and SameSite=Strict, expire after 12 hours or a service restart, and state changes require X-VMBook. Repeated failures from one address receive increasing delays.

Built-in browser client

https://host:3333/ serves VMBook’s own interface, consoles and trusted remotes. It loads no resources from other sites and refuses framing. File selection and drag operations that require the local desktop are identified as app-only.