​
Replace HTTPS Edge Route IP Restriction Module

​
Request

PUT /edges/https/{edge_id}/routes/{id}/ip_restriction

​
Example Request

curl \
-X PUT \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"enabled":true,"ip_policy_ids":["ipp_32ELHryuZB0IOmXGmywHNqY1GTv","ipp_32ELHqtFblQaDl6fUdY3Ph4RjrM"]}' \
https://api.ngrok.com/edges/https/edghts_32ELHqqxM9ZSjjV9gOAdS5s5xd2/routes/edghtsrt_32ELHokrfqrJY2A6woDOpEafX1a/ip_restriction

​
Parameters

NameTypeDescription
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified
ip_policy_idsList<string>list of all IP policies that will be used to check if a source IP is allowed access to the endpoint

​
Response

Returns a 200 response on success

​
Example Response

{
  "enabled": true,
  "ip_policies": [
    {
      "id": "ipp_32ELHryuZB0IOmXGmywHNqY1GTv",
      "uri": "https://api.ngrok.com/ip_policies/ipp_32ELHryuZB0IOmXGmywHNqY1GTv"
    },
    {
      "id": "ipp_32ELHqtFblQaDl6fUdY3Ph4RjrM",
      "uri": "https://api.ngrok.com/ip_policies/ipp_32ELHqtFblQaDl6fUdY3Ph4RjrM"
    }
  ]
}

​
Fields

NameTypeDescription
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified
ip_policiesReflist of all IP policies that will be used to check if a source IP is allowed access to the endpoint

​
Ref fields

NameTypeDescription
idstringa resource identifier
uristringa uri for locating a resource

​
Get HTTPS Edge Route IP Restriction Module

​
Request

GET /edges/https/{edge_id}/routes/{id}/ip_restriction

​
Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_32ELHqqxM9ZSjjV9gOAdS5s5xd2/routes/edghtsrt_32ELHokrfqrJY2A6woDOpEafX1a/ip_restriction

​
Response

Returns a 200 response on success

​
Example Response

{
  "enabled": true,
  "ip_policies": [
    {
      "id": "ipp_32ELHryuZB0IOmXGmywHNqY1GTv",
      "uri": "https://api.ngrok.com/ip_policies/ipp_32ELHryuZB0IOmXGmywHNqY1GTv"
    },
    {
      "id": "ipp_32ELHqtFblQaDl6fUdY3Ph4RjrM",
      "uri": "https://api.ngrok.com/ip_policies/ipp_32ELHqtFblQaDl6fUdY3Ph4RjrM"
    }
  ]
}

​
Fields

NameTypeDescription
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified
ip_policiesReflist of all IP policies that will be used to check if a source IP is allowed access to the endpoint

​
Ref fields

NameTypeDescription
idstringa resource identifier
uristringa uri for locating a resource

​
Delete HTTPS Edge Route IP Restriction Module

​
Request

DELETE /edges/https/{edge_id}/routes/{id}/ip_restriction

​
Example Request

curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_32ELHqqxM9ZSjjV9gOAdS5s5xd2/routes/edghtsrt_32ELHokrfqrJY2A6woDOpEafX1a/ip_restriction

​
Response

Returns a 204 response with no body on success