API reference

Find VMBook hosts and respect provider ownership

Use mDNS as a discovery hint, pin identity separately and operate libvirt machines without taking over their definitions.

Network discovery

An enabled API advertises _vmbook._tcp on physical local-network cards with name, port, API version, VMBook version, OS and fingerprint. Use vmbook --find, avahi-browse or dns-sd to discover it.

Discovery is not identity

Anyone on the network can claim a name or fingerprint in mDNS. Compare the real SHA-256 public-key fingerprint through another trusted channel before saving a token. Later connections must hold to that pin.

Disable advertisement

Set advertise to false in api.json to stop announcing the service. Clients that already know its address may still connect.

Provider-owned Linux machines

Linux machine lists include readable libvirt domains with IDs beginning lv-. VMBook asks libvirt to start, shut down, pause, resume, reset or power them off. Settings remain in libvirt, so PATCH and PUT return a conflict rather than rewriting native XML.

Native authorization still applies

The VMBook service user must have the libvirt rights required for an action. A machine may be visible through a read-only connection while a lifecycle request correctly fails until host permissions are granted.