Quick Links

/docs/cli-flags/docs/troubleshooting/docs/webhooks/solutions/docs/referrals

Answer-first summary

Where should I start in InstaTunnel docs?

Follow this order: Install CLI, authenticate, run first tunnel, then move to MCP/webhooks/referrals based on your use case. Use CLI Flags and Troubleshooting for day-to-day operations.

Last reviewed: March 5, 2026
Compatibility: Core docs align with CLI v1 default and MCP --transport v2 for streaming clients.

Quick command

instatunnel auth login -e you@example.com && instatunnel 3000 --subdomain docs-demo

Common failures and quick fixes

  • Auth not persisted-Run instatunnel auth set-key it_your_api_key to store your key locally.
  • Webhook 401 signature errors-Use provider-specific secret verification guides in /docs/webhooks before production tests.

Evidence and trust

Use these references when evaluating compatibility, reliability, and security posture.

Release cadence

CLI and docs release notes are updated continuously, with version-specific compatibility notes.

View release notes

Security controls

Review policy enforcement, auth layers, and operational safeguards in the security whitepaper.

Open security whitepaper

Reliability runbooks

Troubleshooting guides cover common failures, recovery steps, and CLI compatibility baselines.

Read troubleshooting guides

Documentation

Analytics

Monitor your tunnel usage with basic analytics and request logging. Pro users get advanced analytics and detailed insights.

📊 Usage Analytics (Pro Feature)

Basic Analytics Summary

# View analytics summary (requires account)
$ curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.instatunnel.my/api/analytics/summary?days=7
✅ Analytics available for authenticated users

⚠️ Note: Basic analytics are available to all authenticated users. Advanced analytics require a Pro plan.

Tunnel Analytics API

# Get tunnel-specific analytics (Pro required)
$ curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.instatunnel.my/api/analytics/tunnel/123?days=7
# Get tunnel request logs (Pro required)
$ curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.instatunnel.my/api/analytics/tunnel/123/requests?limit=100
Available Analytics:
  • • Basic: Request counts and general usage (Free)
  • • Advanced: Detailed logs and analytics (Pro)

Plan Limitations

# Free plan response for detailed analytics
$ curl -H "Authorization: Bearer FREE_USER_KEY" \
https://api.instatunnel.my/api/analytics/tunnel/123
HTTP 200 OK
{
"tunnel_id": 123,
"message": "Upgrade to Pro for detailed analytics"
}

Free users receive upgrade prompts when accessing advanced analytics features.

📈 Web Dashboard

Dashboard Access

# Access web dashboard
Visit: https://dashboard.instatunnel.my
📊 View tunnel analytics and management
🔑 Login with your InstaTunnel account
# Features available in dashboard:
• View all active tunnels
• Basic analytics (all users)
• Advanced analytics (Pro users)

The web dashboard provides a visual interface for managing tunnels and viewing analytics.

Analytics Limitations by Plan

Free Plan
  • • Basic request counts
  • • Simple usage summaries
  • • 7-day data retention
  • • Dashboard access
Pro Plan
  • • Detailed analytics
  • • Request logs with full data
  • • Extended data retention
  • • Advanced dashboard features

Analytics API Response Structure

# Sample analytics response (Pro plan)
GET /api/analytics/summary?days=7
{
"user_id": 123,
"period_days": 7,
"total_requests": 1247,
"total_tunnels": 5,
"unique_visitors": 23
}

Analytics data is available via REST API for authenticated users.

📊 API Endpoints

Available Analytics Endpoints

# Get user analytics summary
GET /api/analytics/summary?days=7
Authorization: Bearer YOUR_API_KEY
# Get tunnel-specific analytics (Pro only)
GET /api/analytics/tunnel/:id?days=7
Authorization: Bearer YOUR_API_KEY
# Get tunnel request logs (Pro only)
GET /api/analytics/tunnel/:id/requests?limit=100
Authorization: Bearer YOUR_API_KEY
Analytics Features by Plan:
  • • Summary analytics: Available to all authenticated users
  • • Detailed tunnel analytics: Pro plan required
  • • Request logs: Pro plan required
  • • Days parameter: 1-365 days supported

Error Responses

# Free user accessing Pro features
GET /api/analytics/tunnel/123
HTTP 200 OK
{
"tunnel_id": 123,
"message": "Upgrade to Pro for detailed analytics"
}
# Unauthorized access
GET /api/analytics/summary
HTTP 401 Unauthorized
{"error": "User not found in context"}

Analytics endpoints return clear upgrade prompts for plan limitations.

📊 Analytics Summary: InstaTunnel provides basic analytics for all authenticated users, with advanced analytics available to Pro subscribers. Access your analytics via the web dashboard at https://dashboard.instatunnel.my or through the REST API.

Need a quick path?

See plans, then jump into a guided start whenever you are ready.

For MCP endpoints on Pro/Business, use: instatunnel 8787 --mcp.

View PricingWebhook GuidesUse Cases HubGet Started Guide
InstaTunnel Docs | CLI, Webhook Testing, MCP & Troubleshooting