ngrok API
The ngrok API provides programmatic access to all of ngrok's resources. The API is REST-ish, follows most REST conventions, and listens only on port 443 to avoid accidental unencrypted requests. All API access requires an API key. Resources include endpoints, tunnels, edges (HTTPS, TCP, TLS), backends, reserved domains and addresses, IP policies and restrictions, TLS and SSH certificates, event subscriptions, API keys, and credentials.
Documentation
Specifications
Schemas & Data
JSONSchema
json-schema/tunnel.json
JSONSchema
json-schema/endpoint.json
JSONSchema
json-schema/https-edge.json
JSONSchema
json-schema/tcp-edge.json
JSONSchema
json-schema/tls-edge.json
JSONSchema
json-schema/reserved-domain.json
JSONSchema
json-schema/reserved-addr.json
JSONSchema
json-schema/api-key.json
JSONSchema
json-schema/ip-policy.json
JSONSchema
json-schema/tls-certificate.json
JSONSchema
json-schema/event-subscription.json
JSONSchema
json-schema/tunnel-session.json
SDKs
OpenAPI
#API Gateway
#Compute
#Demonstration
#Gateways
#Platform
#Proxies
#Servers
#Testing
#Tunnels