ngrok Tunnel Sessions API
Tunnel Sessions represent running ngrok agent connections.
ngrok Tunnel Sessions API is one of 24 APIs that ngrok publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 12 JSON Schema definitions.
Tagged areas include Tunnel Sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, a GitHub repository, and 12 JSON Schemas.
This API exposes 5 operations across 5 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.ngrok.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
ngrok Tunnel Sessions API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
An API key is passed in the header as Authorization (apiKeyAuth).
By default, every request must be authenticated.
bearerAuth— Use an ngrok API key as a Bearer token. Create API keys from the ngrok dashboard or via the API Keys endpoints.apiKeyAuth— Pass the API key in the Authorization header prefixed with 'Bearer '.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Tunnel Sessions represent running ngrok agent connections.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are TunnelSession (10 properties), TunnelSessionList (3 properties), Ref (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ngrok 12
Other APIs ngrok publishes across the network.