Skip to main content

Create a device tunnel

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

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. In addition, a tunnel's maximum lifetime is 3600 seconds, after which it is closed regardless of activity.

Required fields:

  • serviceType: Protocol label for the tunnel: "ssh", "http", "https", "vnc", "rdp", "mqtt", "webssh", "webvnc". Does not change how the tunnel is built; only "webssh" causes webSsh to be returned on the response.
  • applicationHost: The intranet IP address of the edge device's target service (e.g. "127.0.0.1"). 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: 1–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​

The newly created tunnel session.