Creates a new route on an HTTPS edge in ngrok. Routes define how traffic matching specific patterns should be handled and can include various security and transformation modules. Use when you need to configure routing rules for an HTTPS edge with optional modules like OAuth, IP…
oidcobjectOIDC configuration for the route.
samlobjectSAML configuration for the route.
matchRequiredstringRoute selector: '/blog' or 'example.com' or 'example.com/blog'
oauthobjectOAuth configuration for the route.
backendobjectBackend configuration for the route.
edge_idRequiredstringUnique identifier of the HTTPS edge to create the route on
metadatastringArbitrary user-defined machine-readable data of this route. Optional, max 4096 bytes
match_typeRequiredstringType of match to use for this route. Valid values are 'exact_path' and 'path_prefix'
compressionobjectCompression configuration for the route.
descriptionstringHuman-readable description of what this route will be used for. Optional, max 255 bytes
ip_restrictionobjectIP restriction configuration for the route.
traffic_policyobjectTraffic policy configuration for the route.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.