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.

Connectionstring required

WebSocket protocol required header

Upgradestring required

WebSocket protocol required header

Changed in 4 of the 32 revisions of this API.22

Feb 6, 20250e915eea7aec1See the full diff
- ▲
  for the query request parameter wait, default value 10 was added
  request-parameter-default-value-added
Mar 27, 2023cdbab610e8721See the full diff
- ○
  added the new optional query request parameter wait
  new-optional-request-parameter
Mar 14, 20232ad125bdbe8c1See the full diff
- ○
  endpoint added
  endpoint-added
Jan 26, 20234b9547159dde1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog