NGngrok
Tunnels

Get

Get the status of a tunnel by ID

get/tunnels/{id}

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/tunnels/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

a resource identifier

Headers

ngrok-versioninteger required

Response

Get the status of a tunnel by ID

idstring

unique tunnel resource identifier

public_urlstring

URL of the ephemeral tunnel's public endpoint

started_atstring

timestamp when the tunnel was initiated in RFC 3339 format

metadatastring

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.

protostring

tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls

regionstring

identifier of tune region where the tunnel is running

labelsobject

the labels the tunnel group backends will match against, if this is a backend tunnel

forwards_tostring

upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.

Changes

No recorded changes to this operation across all 10 revisions of this API.