latestOpenAPI 3.1.02026-08-20118225279.6 KB

126e47974033

Tunnel

Get Tunnel Status Endpoint

Get status of a specific tunnel.

get/api/v1/tunnel/{tunnel_id}

tunnel_idstring required

Successful Response

tunnel_idstring required

Unique tunnel identifier

namestring nullable

Friendly name if set

status'pending' | 'connected' | 'disconnected' | 'expired' | 'terminated' required

hostnamestring required

Tunnel hostname

urlstring required

Full HTTPS URL

local_portinteger required

Local port forwarded by the tunnel

labelsstring[]

Tunnel labels

http_userstring nullable

HTTP basic auth username, if auth is enabled

auth_enabledboolean

Whether HTTP basic auth protects tunnel traffic

created_atstring date-time required

Tunnel creation time

connected_atstring date-time nullable

When the client connected

expires_atstring date-time required

Token expiration time

terminated_atstring date-time nullable

When the tunnel was terminated

user_idstring required

Owner user ID

team_idstring nullable

Team ID if applicable