NGngrok
TunnelSessions

List

Changed on

List all online tunnel sessions running on this account.

get/tunnel_sessions

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/tunnel_sessions
  • Auth
    HTTP bearer

Query parameters

before_idstring

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

limitstring

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

filterstring

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. Filterable fields: id, metadata, agent_version, ip, os, region, started_at, credential

Headers

ngrok-versioninteger required

Response

List all online tunnel sessions running on this account.

uristring

URI to the API resource of the tunnel session list

next_page_uristring

URI of the next page, or null if there is no next page

Changes