Skip to main content
GET
/
tunnel_sessions
List
curl --request GET \
  --url https://api.ngrok.com/tunnel_sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "tunnel_sessions": [
    {
      "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>"
    }
  ],
  "uri": "<string>",
  "next_page_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

Query Parameters

​
before_id
string

Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.

​
limit
string

Constrains the number of results in the dataset. See the API Overview for details.

​
filter
string

A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

Response

200 - application/json

List all online tunnel sessions running on this account.

​
tunnel_sessions
object[]

list of all tunnel sessions on this account

​
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