New — Iris AI drafts your firewall, routing & rate-limit rules. Explore AI features →
Changelog
CLI & MCP

The whole ngris API from your terminal: ngris api

ngris api runs any ngris API action from your terminal, as a table, JSON or a jq filter. On its own it opens a shell with tab completion.

The whole ngris API from your terminal: ngris api

The CLI covered tunnels and deploys. For anything else, such as a database backup, an alert rule or an audit log entry, you opened the dashboard or wrote your own curl against the API.

ngris api puts the whole API in your terminal. Above, Maya lists Acme Labs' applications, then pulls just their names with --jq for a script.

ngris api help: the usage lines for the shell, one command, ngris api request and help
ngris api help lists every resource and its actions; ngris api help applications list shows one action's arguments and options.

What changed

  • ngris api <resource> <action>, for example ngris api applications list or ngris api endpoints get <uuid>. Short names work too, such as apps.
  • Output as a table, --json for the API's own answer, --all for every page, --quiet for IDs only, and --jq '<filter>' to pick what you need.
  • An interactive shell. ngris api on its own opens a shell with tab completion and history. Pipe commands to it in a script, one per line.
  • Anything else. ngris api request <METHOD> <path> calls any API path, with a body from --data, a file or -f key=value.
  • Risky changes ask first. Deletes and other risky actions ask in the shell, and need --yes in a script. Actions an account key can't use are marked in the help.
  • Keys stay yours. A key or token that an action creates is shown once. The CLI keeps the command list and the shell history in ~/.ngris, readable only by you, and never a key or a secret.
  • Always current. The list of commands comes from ngris, so new API actions appear without a CLI update.

Get started

  1. Update ngris to 0.5.0.
  2. Save your API key once with ngris auth --api-key, or set NGRIS_API_KEY. An account key works too.
  3. Run ngris api help, then try ngris api apps list.
  4. Read the docs: The ngris API from your terminal.

Read the docs

Ask an AI to summarise this page
Deploy
App hosting Edge functions Domains & certificates
Connect
Secure tunnels API gateway Multi-region edge
Protect
Bot protection & challenge WAF & firewall Edge login
Observe & AI
Monitoring Inspector & replay Iris AI MCP server AI Gateway
Developers
Developer tools Docs ngrok policy converter Blog Changelog
Compare
Ngris vs ngrok Ngris vs Cloudflare Tunnel Ngris vs Vercel Ngris vs Netlify Expose localhost guide
More
Solutions Pricing Enterprise Sign in Get Started Free