Skip to main content
cURL
Tunnels are not available to customers yet. The production service is disabled pending browser-domain isolation, and the planned signed CLI 0.13.1 release is not yet published. This page documents the prepared API contract; it does not enable the service. See local tunnels for planned use and risks.
Requires an enabled tunnel capability and an account eligible to use tunnels. A new tunnel is private and points to one fixed literal loopback target. Its assigned website URL uses HTTPS; the local server can use HTTP or verified HTTPS. Creation returns the tunnel record and separate connector and lease credentials. Keep both credentials secret and out of logs. Creating the record does not connect your laptop or deploy an application. The foreground tunnel command creates a record and runs its connector together, managing the lease for you. See local tunnels for access modes, local HTTPS setup, and operating limits.

Authorizations

Authorization
string
header
required

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

Body

application/json
target
object
required

Response

connect_url
string
required
connector_token
string
required
lease_token
string
required
lease_ttl_seconds
integer<int64>
required
Required range: x >= 0
lease_url
string
required
max_slots
integer<int32>
required
Required range: x >= 0
tunnel
object
required