Create a private tunnel.

Creates a tunnel and, when token is set, its token. The token's value is returned once and never stored. It runs this one tunnel and does nothing else: lim tunnel run --token <token>.

post/v1/organizations/{organizationId}/tunnels

Request

  • Base URL: https://api.limrun.com
  • URL: https://api.limrun.com/v1/organizations/{organizationId}/tunnels
  • Auth: none declared

Path parameters

organizationIdstring required

Organization TID

Request body

namestring required

The name instances use in spec.tunnel: lowercase letters, digits and dashes, at most 63 characters. Cannot be changed.

selectorsstring[] required

Destinations the tunnel serves: host:port for an exact route, or a domain such as api.internal or *.internal. Android instances reach only routes on port 1024 and above.

ephemeralboolean

Marks a quick tunnel that goes away when its connector exits. It needs token, which its connector runs with: lim tunnel run --name <name> --selector <host:port> creates one this way.

Response

Tunnel created.

Changes

No recorded changes to this operation across all 1 revision of this API.