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.
Choose private for the owner, privileged for the owner and invited verified email identities, or public for visitors without Rigbox sign-in. An admitted visitor receives the access your local application provides, including its write and administrative features. Submit the current policy epoch and connection generation from inspect. Public access also requires an affirmative acknowledgment of that exact target fingerprint, policy epoch, and generation. If the tunnel changes, reload and review its target before submitting another update. The invitation list replaces the previous list and is valid only with privileged access. A policy change invalidates existing viewer sessions and closes streams admitted under the previous policy. See local tunnels for sharing behavior.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
expected_connection_generation
integer<int64>
required
expected_policy_epoch
integer<int64>
required
visibility
string
required
allowed_emails
string[]
public_acknowledgment
null | object

Response

allowed_emails
string[]
required
tunnel
object
required