Contents Menu Expand Light mode Dark mode Auto light/dark mode
ngrok-api documentation
ngrok-api documentation

API

  • Client
  • Datatypes
  • Errors

Services

  • Abuse Reports
  • Agent Ingresses
  • API Keys
  • Application Sessions
  • Application Users
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Static Backends
  • Tunnel Group Backends
  • Weighted Backends
  • Bot Users
  • Certificate Authorities
  • Tunnel Credentials
  • HTTPS Edge Routes
  • HTTPS Edges
  • HTTPS Edge Mutual TLS Module
  • HTTPS Edge TLS Termination Module
  • HTTPS Edge Route Backend Module
  • HTTPS Edge Route IP Restriction Module
  • HTTPS Edge Route Request Headers Module
  • HTTPS Edge Route Response Headers Module
  • HTTPS Edge Route Compression Module
  • HTTPS Edge Route Circuit Breaker Module
  • HTTPS Edge Route Webhook Verification Module
  • HTTPS Edge Route OAuth Module
  • HTTPS Edge Route SAML Module
  • HTTPS Edge Route OIDC Module
  • HTTPS Edge Route Websocket TCP Converter Module
  • HTTPS Edge Route User Agent Filter Module
  • HTTPS Edge Route Traffic Policy Module
  • TCP Edges
  • TCP Edge Backend Module
  • TCP Edge IP Restriction Module
  • TCP Edge Traffic Policy Module
  • TLS Edges
  • TLS Edge Backend Module
  • TLS Edge IP Restriction Module
  • TLS Edge Mutual TLS Module
  • TLS Edge TLS Termination Module
  • TLS Edge Traffic Policy Module
  • Endpoints
  • Event Destinations
  • Event Subscriptions
  • Event Sources
  • IP Policies
  • IP Policy Rules
  • IP Restrictions
  • Reserved Addresses
  • Reserved Domains
  • SSH Certificate Authorities
  • SSH Credentials
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • Tunnels
Back to top
Copyright © 1980, ngrok Inc.
Made with Sphinx and @pradyunsg's Furo