OPopenai
vms

Port-forward to a VM using WebSocket protocol

Changed on

Connect to a VM's TCP port, a declared host process, or its Tart Guest Agent. Specify exactly one of port, hostProcess, or target=tart-guest-agent.

Connecting to Tart Guest Agent requires either the compute:write or compute:connect:tart-guest-agent role.

get/vms/{name}/port-forward

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: Connection, Upgrade

Query parameters

portinteger

VM's TCP port number to connect to; mutually exclusive with hostProcess and target.

hostProcessstring

Name of a host process declared in the VM's hostProcesses field; mutually exclusive with port and target.

target'tart-guest-agent'

Forward to the specified target; mutually exclusive with port and hostProcess.

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

Changes