Bearer authentication header of the form Bearer <token> , where <token> is your auth token.
a resource identifier
Get the status of a tunnel by ID
unique tunnel resource identifier
URL of the ephemeral tunnel's public endpoint
timestamp when the tunnel was initiated in RFC 3339 format
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 .
tunnel protocol for ephemeral tunnels. one of http , https , tcp or tls
identifier of tune region where the tunnel is running
reference object pointing to the tunnel session on which this tunnel was started
Show child attributes
the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel
the labels the tunnel group backends will match against, if this is a backend tunnel
tunnel group backends served by this backend tunnel
upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.
Was this page helpful?