Edge Route Policies Module

Replace HTTPS Edge Route Policies Module

Request

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

Example Request

curl \
-X PUT \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"enabled":true,"inbound":[{"expressions":["req.Method == \"POST\" \u0026\u0026 req.ContentLength \u003e 10000","conn.Geo.CountryCode in ['BR', 'CN', 'CU', 'IR', 'NG', 'RO', 'RU', 'SD', 'SY', 'UA']"],"actions":[{"type":"custom-response","config":{"content":"access denied","content_type":"text/plain","status_code":401}}],"name":"Block POST Requests With Large Content Length From Specific Countries."},{"expressions":["\"SuspiciousAgent\" in req.Headers[\"User-Agent\"]","\"BadActor\" in req.Headers[\"User-Agent\"]","\"RudeDudes\" in req.Headers[\"User-Agent\"]","\"Scalawags\" in req.Headers[\"User-Agent\"]"],"actions":[{"type":"deny","config":{"status_code":400}}],"name":"Block User Agents."}],"outbound":[{"expressions":["res.ContentLength \u003c 500000"],"actions":[{"type":"log","config":{"Metadata":{"Message":"response exceeded threshold."}}}],"name":"Log When Response Size \u003c 500000"}]}' \
https://api.ngrok.com/edges/https/edghts_2bIPilNTZNhDW8V58Fu20fyP5le/routes/edghtsrt_2bIPimK5A2tL1v5uizJkP195Qpp/policies

Parameters

Name	Type	Description
enabled	boolean
inbound	EndpointPolicy
outbound	EndpointPolicy

EndpointPolicy parameters

Name	Type	Description
expressions	List<string>
actions	EndpointAction
name	string

EndpointAction parameters

Name	Type	Description
type	string
config	object

Response

Returns a 200 response on success

Example Response

{
	"enabled": true,
	"inbound": [
		{
			"expressions": [
				"req.Method == \"POST\" \u0026\u0026 req.ContentLength \u003e 10000",
				"conn.Geo.CountryCode in ['BR', 'CN', 'CU', 'IR', 'NG', 'RO', 'RU', 'SD', 'SY', 'UA']"
			],
			"actions": [
				{
					"type": "custom-response",
					"config": {
						"content": "access denied",
						"content_type": "text/plain",
						"status_code": 401
					}
				}
			],
			"name": "Block POST Requests With Large Content Length From Specific Countries."
		},
		{
			"expressions": [
				"\"SuspiciousAgent\" in req.Headers[\"User-Agent\"]",
				"\"BadActor\" in req.Headers[\"User-Agent\"]",
				"\"RudeDudes\" in req.Headers[\"User-Agent\"]",
				"\"Scalawags\" in req.Headers[\"User-Agent\"]"
			],
			"actions": [
				{
					"type": "deny",
					"config": {
						"status_code": 400
					}
				}
			],
			"name": "Block User Agents."
		}
	],
	"outbound": [
		{
			"expressions": ["res.ContentLength \u003c 500000"],
			"actions": [
				{
					"type": "log",
					"config": {
						"Metadata": {
							"Message": "response exceeded threshold."
						}
					}
				}
			],
			"name": "Log When Response Size \u003c 500000"
		}
	]
}

Fields

Name	Type	Description
enabled	boolean
inbound	EndpointPolicy
outbound	EndpointPolicy

EndpointPolicy fields

Name	Type	Description
expressions	List<string>
actions	EndpointAction
name	string

EndpointAction fields

Name	Type	Description
type	string
config	object

Get HTTPS Edge Route Policies Module

Request

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

Example Request

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

Response

Returns a 200 response on success

Example Response

{
	"enabled": true,
	"inbound": [
		{
			"expressions": [
				"req.Method == \"POST\" \u0026\u0026 req.ContentLength \u003e 10000",
				"conn.Geo.CountryCode in ['BR', 'CN', 'CU', 'IR', 'NG', 'RO', 'RU', 'SD', 'SY', 'UA']"
			],
			"actions": [
				{
					"type": "custom-response",
					"config": {
						"content": "access denied",
						"content_type": "text/plain",
						"status_code": 401
					}
				}
			],
			"name": "Block POST Requests With Large Content Length From Specific Countries."
		},
		{
			"expressions": [
				"\"SuspiciousAgent\" in req.Headers[\"User-Agent\"]",
				"\"BadActor\" in req.Headers[\"User-Agent\"]",
				"\"RudeDudes\" in req.Headers[\"User-Agent\"]",
				"\"Scalawags\" in req.Headers[\"User-Agent\"]"
			],
			"actions": [
				{
					"type": "deny",
					"config": {
						"status_code": 400
					}
				}
			],
			"name": "Block User Agents."
		}
	],
	"outbound": [
		{
			"expressions": ["res.ContentLength \u003c 500000"],
			"actions": [
				{
					"type": "log",
					"config": {
						"Metadata": {
							"Message": "response exceeded threshold."
						}
					}
				}
			],
			"name": "Log When Response Size \u003c 500000"
		}
	]
}

Fields

Name	Type	Description
enabled	boolean
inbound	EndpointPolicy
outbound	EndpointPolicy

EndpointPolicy fields

Name	Type	Description
expressions	List<string>
actions	EndpointAction
name	string

EndpointAction fields

Name	Type	Description
type	string
config	object

Delete HTTPS Edge Route Policies Module

Request

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

Example Request

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

Response

Returns a 204 response with no body on success