Skip to main content
GET
/
edges
/
tcp
/
{id}
/
ip_restriction
Get
curl --request GET \
  --url https://api.ngrok.com/edges/tcp/{id}/ip_restriction \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "enabled": true,
  "ip_policies": [
    {
      "id": "<string>",
      "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

Path Parameters

id
string
required

a resource identifier

Response

200 - application/json

n/a

enabled
boolean

true if the module will be applied to traffic, false to disable. default true if unspecified

ip_policies
object[]

list of all IP policies that will be used to check if a source IP is allowed access to the endpoint