cURL
curl --request GET \ --url https://api.ngrok.com/tunnels \ --header 'Authorization: Bearer <token>' \ --header 'ngrok-version: <ngrok-version>'
{ "tunnels": [ { "id": "<string>", "public_url": "<string>", "started_at": "<string>", "metadata": "<string>", "proto": "<string>", "region": "<string>", "tunnel_session": { "id": "<string>", "uri": "<string>" }, "endpoint": { "id": "<string>", "uri": "<string>" }, "labels": {}, "backends": [ { "id": "<string>", "uri": "<string>" } ], "forwards_to": "<string>" } ], "uri": "<string>", "next_page_uri": "<string>" }
List all tunnels in your ngrok account. Note: The Tunnels endpoint is deprecated in favor of Endpoints.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
List all online tunnels currently running on the account.
the list of all online tunnels on this account
Show child attributes
URI of the tunnels list API resource
URI of the next page, or null if there is no next page
Was this page helpful?