---
title: "Get"
method: GET
path: "/tunnel_sessions/{id}"
tags: ["TunnelSessions"]
---

# Get

`GET /tunnel_sessions/{id}`

Get the detailed status of a tunnel session by ID

## Path parameters

- `id` string, required

## Headers

- `ngrok-version` integer, required

## Response `200`

Get the detailed status of a tunnel session by ID

- TunnelSession
  - `agent_version` string — version of the ngrok agent that started this ngrok tunnel session
  - `credential` Ref
    - `id` string — a resource identifier
    - `uri` string — a uri for locating a resource
  - `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

---

[API](https://skmtc.net/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.net/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/versions/1994bbb04714/schema)
