Sign in
TunnelSessions

Get

Get the detailed status of a tunnel session by ID

get/tunnel_sessions/{id}

Path parameters

idstring required

a resource identifier

Headers

ngrok-versioninteger required

Response

Get the detailed status of a tunnel session by ID

agent_versionstring

version of the ngrok agent that started this ngrok tunnel session

idstring

unique tunnel session resource identifier

ipstring

source ip address of the tunnel session

metadatastring

arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option

osstring

operating system of the host the ngrok agent is running on

regionstring

the ngrok region identifier in which this tunnel session was started

started_atstring

time when the tunnel session first connected to the ngrok servers

transportstring

the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh

uristring

URI to the API resource of the tunnel session

Changes

No recorded changes to this endpoint across all 9 revisions of this API.