v1

latestSwagger 2.02026-08-06114111152.5 KB

Tunnel

Get the user's active tunnel

Returns the first active tunnel for the authenticated account (regardless of ID). Convenience endpoint when you only run one tunnel at a time.

get/v1/tunnel

idinteger required

Unique numeric tunnel ID.

statestring required

Tunnel lifecycle state (READY, STOPPED, …).

launchedstring date-time required

When the tunnel was launched.

tunnel_idstring required

Public tunnel identifier surfaced in the dashboard.

identifierstring required

Custom name passed via --tunnel-identifier on the client.

metadataobject required

Free-form metadata (client version, OS, region) reported by the tunnel binary.