---
title: "List"
method: GET
path: "/tunnels"
tags: ["Tunnels"]
---

# List

`GET /tunnels`

List all online tunnels currently running on the account.

## Query parameters

- `before_id` string
- `limit` string

## Headers

- `ngrok-version` integer, required

## Response `200`

List all online tunnels currently running on the account.

- TunnelList
  - `tunnels` Tunnel[] — the list of all online tunnels on this account
    - `id` string — unique tunnel resource identifier
    - `public_url` string — URL of the ephemeral tunnel's public endpoint
    - `started_at` string — timestamp when the tunnel was initiated in RFC 3339 format
    - `metadata` string — user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel [metadata configuration option](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#common-tunnel-configuration-properties) In API version 0, this value was instead pulled from the top-level [metadata configuration option](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#metadata).
    - `proto` string — tunnel protocol for ephemeral tunnels. one of `http`, `https`, `tcp` or `tls`
    - `region` string — identifier of tune region where the tunnel is running
    - `tunnel_session` Ref
      - `id` string — a resource identifier
      - `uri` string — a uri for locating a resource
    - `endpoint` Ref
      - `id` string — a resource identifier
      - `uri` string — a uri for locating a resource
    - `labels` object — the labels the tunnel group backends will match against, if this is a backend tunnel
    - `backends` Ref[] — tunnel group backends served by this backend tunnel
      - `id` string — a resource identifier
      - `uri` string — a uri for locating a resource
    - `forwards_to` string — upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.
  - `uri` string — URI of the tunnels list API resource
  - `next_page_uri` string — URI of the next page, or null if there is no next page

---

[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)