Skip to main content
GET
/
tunnel_sessions
/
{id}
Get
curl --request GET \
  --url https://api.ngrok.com/tunnel_sessions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "agent_version": "<string>",
  "credential": {
    "id": "<string>",
    "uri": "<string>"
  },
  "id": "<string>",
  "ip": "<string>",
  "metadata": "<string>",
  "os": "<string>",
  "region": "<string>",
  "started_at": "<string>",
  "transport": "<string>",
  "uri": "<string>"
}

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 the detailed status of a tunnel session by ID

​
agent_version
string

version of the ngrok agent that started this ngrok tunnel session

​
credential
object

reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session

​
id
string

unique tunnel session resource identifier

​
ip
string

source ip address of the tunnel session

​
metadata
string

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

​
os
string

operating system of the host the ngrok agent is running on

​
region
string

the ngrok region identifier in which this tunnel session was started

​
started_at
string

time when the tunnel session first connected to the ngrok servers

​
transport
string

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

​
uri
string

URI to the API resource of the tunnel session