Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Tunnel

Hierarchy

  • Tunnel

Index

Properties

id

id: string

unique tunnel resource identifier

metadata

metadata: string

user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel metadata configuration option In API version 0, this value was instead pulled from the top-level metadata configuration option.

proto

proto: string

tunnel protocol. one of http, https, tcp or tls

publicUrl

publicUrl: string

URL of the tunnel's public endpoint

region

region: string

identifier of tune region where the tunnel is running

startedAt

startedAt: string

timestamp when the tunnel was initiated in RFC 3339 format

tunnelSession

tunnelSession: Ref

reference object pointing to the tunnel session on which this tunnel was started

Generated using TypeDoc