Tunnel Management

Overview

WEDA Tunnel Management lets a customer reach any service running on any registered edge device - SSH, RDP, VNC, web consoles, MQTT brokers - from one console, in seconds, without ever opening a port on the device's network.

Basic Operations

Basic API URL: https://{domain}/{tenantPath}/{srp}

Operation	API	Description
Creates a tunnel session	POST {Basic API URL}/api/v1/devices/{deviceId}/tunnels/sessions	Create and start a new tunnel session for a specific device
Get tunnel sessions	GET {Basic API URL}/api/v1/devices/{deviceId}/tunnels/sessions	Get active tunnel sessions of a specific device
Get tunnel session details	GET {Basic API URL}/api/v1/devices/{deviceId}/tunnels/sessions/{tunnelSessionId}	Get details of a specific tunnel session
Terminate a tunnel session	POST {Basic API URL}/api/v1/devices/{deviceId}/tunnels/sessions/{tunnelSessionId}	Terminate a specific tunnel session

Constraints & Limitations

General

• API access requires authentication with a valid token
• Device must be online and registered to create tunnel sessions

Create

• serviceType is required, must be one of ssh, http, https, vnc, rdp, mqtt, default is ssh.
• applicationHost is required, must be a valid IP address or domain name.
• applicationPort is required, must be an integer between 0 and 65535.

Delete

• Only active tunnel sessions can be terminated. Sessions that are already terminated or failed cannot be terminated again.
• graceful termination is recommended to allow existing connections to close cleanly. Forceful termination may result in abrupt disconnections for users connected through the tunnel.
• forceTimeout should be set to a reasonable value (e.g., 30 seconds) to allow for graceful shutdown before forcing closure. Setting it too low may not give enough time for connections to close properly, while setting it too high may delay the termination process unnecessarily.

---

Last updated on Apr-8, 2026 | Version 1.0.0