Skip to main content
GET
List Tunnels Endpoint

Rate Limit

300 requests per 60 seconds per user.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

teamId
string | null
status
string | null

Filter by status

labels
string[] | null

Filter by labels

includeTerminated
boolean
default:false

Include terminated tunnels

page
integer
default:1

Page number

Required range: x >= 1
perPage
integer
default:50

Items per page

Required range: 1 <= x <= 1000
sortBy
string
default:createdAt
sortOrder
string
default:desc

Response

Successful Response

Response containing list of tunnels.

total
integer
required

Total number of tunnels

tunnels
TunnelStatusResponse · object[]

List of active tunnels

page
integer
default:1

Page number

per_page
integer
default:50

Items per page

has_next
boolean
default:false

Whether more pages are available