v1

latestSwagger 2.02026-08-06114111152.5 KB

Tunnel

Get a specific tunnel

Returns the current state of a tunnel by ID. Returns 500 with the underlying error if the tunnel is in a transition state or no longer exists.

get/v1/tunnel/{id}

idinteger required

Numeric tunnel ID returned by /v1/tunnel/list or /v1/tunnel/create.

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.