Skip to main content

Edge Route User Agent Filter Module

Replace HTTPS Edge Route User Agent Filter Module

Request

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

Example Request

curl \
-X PUT \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"allow":["(Pingdom\\.com_bot_version_)(\\d+)\\.(\\d+)"],"deny":["(made_up_bot)/(\\d+)\\.(\\d+)"],"enabled":true}' \
https://api.ngrok.com/edges/https/edghts_2k5okcp4V0TAXyj2vkkCSqqj0Id/routes/edghtsrt_2k5okaI98zx1vQlYKa6A8aW8gyN/user_agent_filter

Parameters

NameTypeDescription
enabledboolean
allowList<string>
denyList<string>

Response

Returns a 200 response on success

Example Response

{
"allow": ["(Pingdom\\.com_bot_version_)(\\d+)\\.(\\d+)"],
"deny": ["(made_up_bot)/(\\d+)\\.(\\d+)"],
"enabled": true
}

Fields

NameTypeDescription
enabledboolean
allowList<string>
denyList<string>

Get HTTPS Edge Route User Agent Filter Module

Request

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

Example Request

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

Response

Returns a 200 response on success

Example Response

{
"allow": ["(Pingdom\\.com_bot_version_)(\\d+)\\.(\\d+)"],
"deny": ["(made_up_bot)/(\\d+)\\.(\\d+)"],
"enabled": true
}

Fields

NameTypeDescription
enabledboolean
allowList<string>
denyList<string>

Delete HTTPS Edge Route User Agent Filter Module

Request

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

Example Request

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

Response

Returns a 204 response with no body on success