API reference

Act through a trusted computer

List known remotes, inspect their machines and send controlled lifecycle actions.

List remotes

GET /v1/remotes

Returns ID, name, address, port, online state, machines or an error. VMBook uses stored pins and tokens for outbound connections.

Remote machines

GET /v1/remotes/{remote}/machines

An unavailable or rejected upstream may return 502.

Remote actions

POST /v1/remotes/{remote}/machines/{machine}/{action}

The actions match local machines. The remote computer composes and performs the operation.

Trust implications

A token that can invoke stored remotes is transitively powerful. Use separate management tiers and do not turn a broadly accessible workstation into a bridge to protected hosts.