Skip to main content
GET
/
backends
/
tunnel_group
List
curl --request GET \
  --url https://api.ngrok.com/backends/tunnel_group \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "backends": [
    {
      "id": "<string>",
      "uri": "<string>",
      "created_at": "<string>",
      "description": "<string>",
      "metadata": "<string>",
      "labels": {},
      "tunnels": [
        {
          "id": "<string>",
          "uri": "<string>"
        }
      ]
    }
  ],
  "uri": "<string>",
  "next_page_uri": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
ngrok-version
integer
default:2
required

Query Parameters

​
before_id
string
​
limit
string

Response

200 - application/json

List all TunnelGroup backends on this account

​
backends
object[]

the list of all TunnelGroup backends on this account

​
uri
string

URI of the TunnelGroup backends list API resource

​
next_page_uri
string

URI of the next page, or null if there is no next page