HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get the current list of tunnels and their configuration as well as some state information like uptime and operational state

The schema shows a single tunnel object. The return value is a hash map of tunnels keyed by their name. You will see some built-in tunnel names like: default, passthrough and passthrough-unshaped.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The state regular expression which is used to match a tunnel state

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*