Skip to main content
GET
Get

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version
integer
default:2
required

Path Parameters

id
string
required

a resource identifier

Response

200 - application/json

Get detailed information about a TunnelGroup backend by ID

id
string

unique identifier for this TunnelGroup backend

uri
string

URI of the TunnelGroupBackend API resource

created_at
string

timestamp when the backend was created, RFC 3339 format

description
string

human-readable description of this backend. Optional

metadata
string

arbitrary user-defined machine-readable data of this backend. Optional

labels
object

labels to watch for tunnels on, e.g. app->foo, dc->bar

tunnels
object[]

tunnels matching this backend