Skip to main content
GET
/
edges
/
tcp
List
curl --request GET \
  --url https://api.ngrok.com/edges/tcp \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "tcp_edges": [
    {
      "id": "<string>",
      "description": "<string>",
      "metadata": "<string>",
      "created_at": "<string>",
      "uri": "<string>",
      "hostports": [
        "<string>"
      ],
      "backend": {
        "enabled": true,
        "backend": {
          "id": "<string>",
          "uri": "<string>"
        }
      },
      "ip_restriction": {
        "enabled": true,
        "ip_policies": [
          {
            "id": "<string>",
            "uri": "<string>"
          }
        ]
      },
      "traffic_policy": {
        "enabled": true,
        "value": "<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

Returns a list of all TCP Edges on this account

​
tcp_edges
object[]

the list of all TCP Edges on this account

​
uri
string

URI of the TCP Edge list API resource

​
next_page_uri
string

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