CLI reference / cloudflare / route-tunnel

stado cloudflare route-tunnel

Invocation

stado cloudflare route-tunnel [OPTIONS] --api-credential <API_CREDENTIAL> --tunnel-credential <TUNNEL_CREDENTIAL> --zone <ZONE> --hostname <HOSTNAME> --origin <ORIGIN> --host <HOST>

Purpose

Route one hostname to an origin behind a named Cloudflare Tunnel

Required inputs and options

Input or optionContract
--api-credential <API_CREDENTIAL>Stado credential containing the Cloudflare account_id and scoped api_token
--tunnel-credential <TUNNEL_CREDENTIAL>Stado credential containing the same account_id and tunnel_id
--zone <ZONE>Exact Cloudflare zone name, for example bobloo.com
--hostname <HOSTNAME>Exact public hostname to route
--origin <ORIGIN>Connector-local HTTP(S) origin, for example http://localhost on port 3000
--host <HOST>Registry host running the connector
--connector-service <CONNECTOR_SERVICE>Registry-managed connector service on that host [default: cloudflared]
--connector-token-field <CONNECTOR_TOKEN_FIELD>Credential field containing the connector token [default: token]
--connector-secret-name <CONNECTOR_SECRET_NAME>Owner-only token filename under the connector service user's ~/.stado [default: cloudflared-token]
--jsonEmit the nonsecret change report as JSON

Output and state effect

It performs the operation described above and emits its operator result on standard output or standard error. Any state change is limited to the resources and records named by the purpose and options on this page.

Refusals

  • Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.