Skip to main content

Create tunnel session

POST 

/api/v1/devices/{deviceId}/tunnels/sessions

If no client connects to a tunnel within 120 seconds of its creation, the tunnel will be closed automatically. In addition, a tunnel's maximum lifetime is 3600 seconds, after which it is closed regardless of activity.

Required fields:

  • serviceType — Protocol to tunnel (e.g. "ssh", "http", "vnc"). Default: "ssh".
  • applicationHost — The intranet IP address of the edge device's target service (e.g. "192.168.1.100"). Must be a valid IPv4/IPv6 address or hostname reachable from the device's local network.
  • applicationPort — Port the target service is listening on (e.g. 22 for SSH). Range: 0–65535.
  • purpose — Brief justification for creating the tunnel (e.g. "Remote maintenance").
  • tags — A list of free-form labels for categorization, filtering, and auditing (e.g. ["ops", "critical"]). Use tags to group related tunnels, identify ownership, or enable dashboard filtering.

Request

Responses

Accepted