Skip to main content

TunnelAPI Documentation

Welcome to TunnelAPI - the developer-first platform for secure tunneling, API Gateway, Kubernetes Ingress, and webhook testing.

What is TunnelAPI?​

TunnelAPI is a comprehensive developer platform that helps you:

  • 🚇 Expose localhost - Share your local development server with the world via secure HTTPS tunnels
  • 🌐 API Gateway - Route, transform, and load balance API traffic with enterprise-grade features (NEW!)
  • ☸️ K8s Ingress - Kubernetes-compatible ingress controller with YAML import/export (NEW!)
  • 🪝 Test webhooks - Create instant webhook endpoints to capture, inspect, and debug HTTP requests
  • 📊 Collaborate on APIs - Capture and share API responses with your team using shareable project links
  • 🔐 Enterprise-ready - SAML 2.0, OAuth 2.0, and OIDC support for tunnel authentication

Quick Start​

Get started in under 60 seconds:

# Install the CLI
npm install -g api-response-manager

# Login to your account
arm login

# Expose your local server
arm tunnel 3000

Your local server is now accessible at https://your-subdomain.free-tunnelapi.app!

API Gateway Quick Start​

# Create an API Gateway
arm gateway create my-api --backend http://localhost:3000

# Your API is now at: https://my-api-gw.free-tunnelapi.app

Kubernetes Ingress​

# Apply K8s-style ingress
arm ingress apply -f ingress.yaml

# Or create directly
arm ingress create my-app --host my-app-in.free-tunnelapi.app --backend http://localhost:8080

Key Features​

Secure Tunneling​

Expose your localhost to the internet with enterprise-grade security. Perfect for webhooks, demos, and testing.

  • HTTPS/TLS encryption included
  • Custom subdomains
  • TCP and WebSocket support
  • Path-based routing (ingress)

Webhook Testing​

Create instant webhook endpoints to capture, inspect, and replay HTTP requests in real-time.

  • Signature validation
  • Conditional routing
  • Payload transformation
  • Slack, Discord, Email integrations

API Response Capture​

Capture, share, and collaborate on API responses with your team using shareable project links.

  • Real-time updates
  • Team collaboration
  • Comments and annotations
  • Export capabilities

Enterprise Authentication​

Integrate with your identity provider for secure tunnel access.

  • SAML 2.0 SSO
  • OAuth 2.0 / OIDC
  • IP whitelisting
  • Rate limiting

Architecture​

┌─────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│  Your Browser   │────▶│   TunnelAPI.in   │────▶│  Your Localhost │
│  or API Client  │◀────│   (Cloud/Self)   │◀────│    :3000        │
└─────────────────┘     └──────────────────┘     └─────────────────┘
                              │
                              ▼
                        ┌──────────────────┐
                        │   ARM CLI Tool   │
                        │   (WebSocket)    │
                        └──────────────────┘

Ingress Platform​

Enterprise-grade traffic management for your APIs.

  • API Gateway - Route management, load balancing, rate limiting
  • K8s Ingress - Standard networking.k8s.io/v1 API compatible
  • Load Balancing - Round-robin, weighted, IP-hash, least-connections
  • Health Checks - Automatic backend monitoring
  • SSL/TLS - Automatic HTTPS with wildcard certificates

Next Steps​

Support​