Skip to main content
GET
Get Tunnel Status Endpoint

Rate Limit

300 requests per 60 seconds per tunnel.

Authorizations

Authorization
string
header
required

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

Path Parameters

tunnel_id
string
required

Response

Successful Response

Response containing tunnel status information.

tunnel_id
string
required

Unique tunnel identifier

status
enum<string>
required

Current tunnel status

Available options:
pending,
connected,
disconnected,
expired,
terminated
hostname
string
required

Tunnel hostname

url
string
required

Full HTTPS URL

local_port
integer
required

Local port forwarded by the tunnel

created_at
string<date-time>
required

Tunnel creation time

expires_at
string<date-time>
required

Token expiration time

user_id
string
required

Owner user ID

name
string | null

Friendly name if set

labels
string[]

Tunnel labels

http_user
string | null

HTTP basic auth username, if auth is enabled

auth_enabled
boolean
default:false

Whether HTTP basic auth protects tunnel traffic

connected_at
string<date-time> | null

When the client connected

terminated_at
string<date-time> | null

When the tunnel was terminated

team_id
string | null

Team ID if applicable