v1

latestOpenAPI 3.0.02026-07-17212535.2 KB
vms

Port-forward to a VM using WebSocket protocol

get/vms/{name}/port-forward

Query parameters

portinteger required

VM's TCP port number to connect to

waitinteger

Duration in seconds to wait for the VM to transition into "running" state if not already running.

Headers

Connectionstring required

WebSocket protocol required header

Upgradestring required

WebSocket protocol required header