Skip to content
Registry

quick-tunnel

v0.1.0

Manage expiring durable leases on authorized cloudflared Quick Tunnel child processes.

license: Apache-2.0cloudflareleasesquick-tunneltunnelwebhooks

Install

bash
iii trigger compose::add worker=quick-tunnel@0.1.0

Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.

Functions3

quick-tunnel::acquire

Function

Acquire or extend an expiring durable lease for an operator-authorized local target; returns immediately, possibly starting

Request
  • consumer_idstringrequired

    Stable opaque consumer identity; not a credential.

  • expires_atstring· date-timerequired

    Absolute lease expiry in RFC3339, strictly in the future.

  • tunnel_idstring
Response
  • errorstring

    Sanitized lifecycle failure, never raw cloudflared output.

  • generationstringrequired
  • lease_idstringrequired
  • public_urlstring
  • statusstringrequiredenum starting, ready, reconnecting, failed, stopped
  • tunnel_idstringrequired

quick-tunnel::release

Function

Release one lease idempotently; the last lease stops and reaps the tunnel child

Request
  • lease_idstringrequired
Response
  • releasedbooleanrequired

quick-tunnel::status

Function

Read the latest tunnel generation, connection state, public URL and non-secret leases

Request
  • tunnel_idstring
Response
  • errorstring

    Sanitized lifecycle failure, never raw cloudflared output.

  • generationstringrequired
  • leasesobject[]required
    • consumer_idstringrequired
    • expires_atstring· date-timerequired
    • lease_idstringrequired
    • tunnel_idstringrequired
  • public_urlstring
  • statusstringrequiredenum starting, ready, reconnecting, failed, stopped
  • tunnel_idstringrequired

Triggers1

quick-tunnel::changed

Trigger

Tunnel lifecycle snapshot changed; subscribe before acquire, then read status to close races

Invocation
  • tunnel_idstring

    Omit to subscribe to all authorized targets.

Return
  • errorstring

    Sanitized lifecycle failure, never raw cloudflared output.

  • generationstringrequired
  • public_urlstring
  • statusstringrequiredenum starting, ready, reconnecting, failed, stopped
  • tunnel_idstringrequired

Search the registry

Find workers, kits and executables, or jump to a page.