Device Tunnels

Open a temporary tunnel to a service running on a device, such as SSH, HTTP, VNC, or a browser-based SSH session. Create a tunnel session, poll it until it is ESTABLISHED, connect, and terminate it when you are done.

📄️Create a device tunnel

By default, a tunnel that stays in REQUESTED or ESTABLISHING for 60 seconds without a status update is closed automatically. An ESTABLISHED tunnel with no client connection is closed automatically 60 seconds after it was created or after its last connection ended. These rules apply to every serviceType.

📄️List device tunnels

List tunnel sessions for a device. Filter by sessionStatus, serviceType, or tags. Results are sorted by createdAt desc by default.

📄️Get a device tunnel

Get a tunnel session by ID. After creating a tunnel (202), poll this endpoint until sessionStatus is ESTABLISHED and tunnelEndpoint is not null, then connect. By default, an established tunnel that has no connection for 60 seconds is closed automatically.

📄️Terminate a device tunnel

Initiates a graceful or immediate shutdown of the specified tunnel session. In this version, a termination requested through this endpoint currently reports terminationSource as TunnelMgmt instead of User.

📄️Open a browser-based SSH session

Opens the browser-based SSH page for a webssh tunnel session. Open the session's `webSsh` link in a browser; this endpoint does not take a WEDA bearer token. The page is protected by the device's own SSH username and password.