---
title: "List"
method: GET
path: "/tunnel_sessions"
tags: ["TunnelSessions"]
---

# List

`GET /tunnel_sessions`

List all online tunnel sessions running on this account.

## Query parameters

- `before_id` string
- `limit` string
- `filter` string

## Headers

- `ngrok-version` integer, required

## Response `200`

List all online tunnel sessions running on this account.

- TunnelSessionList
  - `tunnel_sessions` TunnelSession[] — list of all tunnel sessions on this account
    - `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
  - `uri` string — URI to the API resource of the tunnel session list
  - `next_page_uri` string — URI of the next page, or null if there is no next page

## Other responses

- `4XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.
- `5XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.

## Changes

- **2025-12-16** `602cd080d3a7` — 1 info
  - added the new optional `query` request parameter `filter`

[Change history](https://skmtc.dev/ngrok/apis/ngrok-openapi/changes/tunnel_sessions/get.md)

---

[API](https://skmtc.dev/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.dev/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/revisions/c697539ac350/schema)