Terminal
Terminal/Skill
Reference for applying an ngrok endpoint and Traffic Policy across the CLI, SDKs, REST API, Terraform, and Kubernetes Operator.
By ngrok
Works with
npx skills add ngrok/skills --skill ngrok-surfacesJob skills decide what to build - the endpoint type and the policy, both in ngrok-engine. This skill decides where to apply it and hands off to the mechanics.
The configuration itself does not change across surfaces. The same policy body, the same endpoint URL, the same internal hostname. Only the wrapper differs. So never re-derive a policy because the user switched surfaces; re-wrap it.
Read it off the user's project rather than asking:
| Signal | Surface | Reference |
|---|---|---|
| A terminal, a port, "just give me a URL" | agent CLI / ngrok.yml | references/cli.md |
package.json, pyproject.toml, go.mod, or Cargo.toml with an ngrok dependency; or the endpoint should live and die with the process | SDK | references/sdk.md |
| A controlplane creating resources per tenant/sandbox/device at runtime | REST API | references/api.md |
*.tf files | Terraform | references/terraform.md |
Chart.yaml, kustomization.yaml, k8s manifests | Kubernetes Operator | references/kubernetes-operator.md |
If none of these is obvious, the CLI is the safe default for a one-off task.
Surfaces differ by when the resource is created and what owns its lifetime:
Terraform and the API look interchangeable and are not. "My account has these three endpoints" is Terraform. "Every sandbox gets one" is the API. See provision-sandbox-access for the latter.
A single setup often uses two: the API or Terraform provisions the public cloud endpoint, and the CLI or SDK brings up the internal endpoint from inside the workload. They rendezvous on an agreed internal hostname.
NGROK_AUTHTOKEN). It starts agent sessions and nothing else.These are not interchangeable and have very different blast radii. If a call fails with an auth error, check which credential is in play before rotating anything. See ngrok-setup.
policy.yaml and reference it. That is what makes it portable when the user adds a second surface later, which they usually do.