HTTPS Edge Routes#

Do not construct this object directly, instead access the edges_https_routes property of an ngrok.Client object.

class ngrok.services.EdgesHTTPSRoutesClient(client)[source]#
create(edge_id, match_type, match, description='', metadata='', backend=None, ip_restriction=None, circuit_breaker=None, compression=None, request_headers=None, response_headers=None, webhook_verification=None, oauth=None, saml=None, oidc=None, websocket_tcp_converter=None)[source]#

Create an HTTPS Edge Route

Parameters:

  • edge_id (str) – unique identifier of this edge

  • match_type (str) – Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.

  • match (str) – Route selector: “/blog” or “example.com” or “example.com/blog”

  • description (str) – human-readable description of what this edge will be used for; optional, max 255 bytes.

  • metadata (str) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

  • backend (Optional[EndpointBackendMutate, None]) – backend module configuration or null

  • ip_restriction (Optional[EndpointIPPolicyMutate, None]) – ip restriction module configuration or null

  • circuit_breaker (Optional[EndpointCircuitBreaker, None]) – circuit breaker module configuration or null

  • compression (Optional[EndpointCompression, None]) – compression module configuration or null

  • request_headers (Optional[EndpointRequestHeaders, None]) – request headers module configuration or null

  • response_headers (Optional[EndpointResponseHeaders, None]) – response headers module configuration or null

  • webhook_verification (Optional[EndpointWebhookValidation, None]) – webhook verification module configuration or null

  • oauth (Optional[EndpointOAuth, None]) – oauth module configuration or null

  • saml (Optional[EndpointSAMLMutate, None]) – saml module configuration or null

  • oidc (Optional[EndpointOIDC, None]) – oidc module configuration or null

  • websocket_tcp_converter (Optional[EndpointWebsocketTCPConverter, None]) – websocket to tcp adapter configuration or null

https://ngrok.com/docs/api#api-edges-https-routes-create

Return type:

HTTPSEdgeRoute

delete(edge_id, id)[source]#

Delete an HTTPS Edge Route by ID

Parameters:

  • edge_id (str) – unique identifier of this edge

  • id (str) – unique identifier of this edge route

https://ngrok.com/docs/api#api-edges-https-routes-delete

get(edge_id, id)[source]#

Get an HTTPS Edge Route by ID

Parameters:

  • edge_id (str) – unique identifier of this edge

  • id (str) – unique identifier of this edge route

https://ngrok.com/docs/api#api-edges-https-routes-get

Return type:

HTTPSEdgeRoute

update(edge_id, id, match_type='', match='', description='', metadata='', backend=None, ip_restriction=None, circuit_breaker=None, compression=None, request_headers=None, response_headers=None, webhook_verification=None, oauth=None, saml=None, oidc=None, websocket_tcp_converter=None)[source]#

Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

Parameters:

  • edge_id (str) – unique identifier of this edge

  • id (str) – unique identifier of this edge route

  • match_type (str) – Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.

  • match (str) – Route selector: “/blog” or “example.com” or “example.com/blog”

  • description (str) – human-readable description of what this edge will be used for; optional, max 255 bytes.

  • metadata (str) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

  • backend (Optional[EndpointBackendMutate, None]) – backend module configuration or null

  • ip_restriction (Optional[EndpointIPPolicyMutate, None]) – ip restriction module configuration or null

  • circuit_breaker (Optional[EndpointCircuitBreaker, None]) – circuit breaker module configuration or null

  • compression (Optional[EndpointCompression, None]) – compression module configuration or null

  • request_headers (Optional[EndpointRequestHeaders, None]) – request headers module configuration or null

  • response_headers (Optional[EndpointResponseHeaders, None]) – response headers module configuration or null

  • webhook_verification (Optional[EndpointWebhookValidation, None]) – webhook verification module configuration or null

  • oauth (Optional[EndpointOAuth, None]) – oauth module configuration or null

  • saml (Optional[EndpointSAMLMutate, None]) – saml module configuration or null

  • oidc (Optional[EndpointOIDC, None]) – oidc module configuration or null

  • websocket_tcp_converter (Optional[EndpointWebsocketTCPConverter, None]) – websocket to tcp adapter configuration or null

https://ngrok.com/docs/api#api-edges-https-routes-update

Return type:

HTTPSEdgeRoute