Merge pull request #14 from ngrok/staging

v0.6.0 - cut new release for ngrok-api-python
This commit is contained in:
Russ Savage authored and GitHub committed 2022-03-11 23:33:52 -08:00
commit 36fd08f1fb
157 files changed
+16080 -5150

No files matched your search

+9
View File
@@ -0,0 +1,9 @@
HTTPS Edge Route Backend Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_backend_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteBackendModuleClient
:undoc-members: EdgeRouteBackendModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Circuit Breaker Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_circuit_breaker_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteCircuitBreakerModuleClient
:undoc-members: EdgeRouteCircuitBreakerModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Compression Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_compression_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteCompressionModuleClient
:undoc-members: EdgeRouteCompressionModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route IP Restriction Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_ip_restriction_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteIPRestrictionModuleClient
:undoc-members: EdgeRouteIPRestrictionModuleClient
+9
View File
@@ -0,0 +1,9 @@
HTTPS Edge Route OAuth Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_o_auth_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteOAuthModuleClient
:undoc-members: EdgeRouteOAuthModuleClient
+9
View File
@@ -0,0 +1,9 @@
HTTPS Edge Route OIDC Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_oidc_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteOIDCModuleClient
:undoc-members: EdgeRouteOIDCModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Request Headers Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_request_headers_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteRequestHeadersModuleClient
:undoc-members: EdgeRouteRequestHeadersModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Response Headers Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_response_headers_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteResponseHeadersModuleClient
:undoc-members: EdgeRouteResponseHeadersModuleClient
+9
View File
@@ -0,0 +1,9 @@
HTTPS Edge Route SAML Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_saml_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteSAMLModuleClient
:undoc-members: EdgeRouteSAMLModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Webhook Verification Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_webhook_verification_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteWebhookVerificationModuleClient
:undoc-members: EdgeRouteWebhookVerificationModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Websocket TCP Converter Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_websocket_tcp_converter_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteWebsocketTCPConverterModuleClient
:undoc-members: EdgeRouteWebsocketTCPConverterModuleClient
+9
View File
@@ -0,0 +1,9 @@
HTTPS Edges
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edges_https` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgesHTTPSClient
:undoc-members: EdgesHTTPSClient
+9
View File
@@ -0,0 +1,9 @@
HTTPS Edge Routes
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edges_https_routes` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgesHTTPSRoutesClient
:undoc-members: EdgesHTTPSRoutesClient
+9
View File
@@ -0,0 +1,9 @@
TCP Edges
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edges_tcp` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgesTCPClient
:undoc-members: EdgesTCPClient
+9
View File
@@ -0,0 +1,9 @@
TLS Edges
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edges_tls` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgesTLSClient
:undoc-members: EdgesTLSClient
@@ -1,9 +0,0 @@
Circuit Breaker Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_circuit_breaker_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointCircuitBreakerModuleClient
:undoc-members: EndpointCircuitBreakerModuleClient
@@ -1,9 +0,0 @@
Compression Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_compression_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointCompressionModuleClient
:undoc-members: EndpointCompressionModuleClient
-9
View File
@@ -1,9 +0,0 @@
Endpoint Configurations
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_configurations` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointConfigurationsClient
:undoc-members: EndpointConfigurationsClient
-9
View File
@@ -1,9 +0,0 @@
IP Policy Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_ip_policy_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointIPPolicyModuleClient
:undoc-members: EndpointIPPolicyModuleClient
-9
View File
@@ -1,9 +0,0 @@
Logging Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_logging_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointLoggingModuleClient
:undoc-members: EndpointLoggingModuleClient
@@ -1,9 +0,0 @@
Mutual TLS Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_mutual_tls_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointMutualTLSModuleClient
:undoc-members: EndpointMutualTLSModuleClient
-9
View File
@@ -1,9 +0,0 @@
OAuth Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_o_auth_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointOAuthModuleClient
:undoc-members: EndpointOAuthModuleClient
-9
View File
@@ -1,9 +0,0 @@
OIDC Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_oidc_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointOIDCModuleClient
:undoc-members: EndpointOIDCModuleClient
@@ -1,9 +0,0 @@
Request Headers Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_request_headers_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointRequestHeadersModuleClient
:undoc-members: EndpointRequestHeadersModuleClient
@@ -1,9 +0,0 @@
Response Headers Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_response_headers_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointResponseHeadersModuleClient
:undoc-members: EndpointResponseHeadersModuleClient
-9
View File
@@ -1,9 +0,0 @@
SAML Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_saml_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointSAMLModuleClient
:undoc-members: EndpointSAMLModuleClient
@@ -1,9 +0,0 @@
TLS Termination Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_tls_termination_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointTLSTerminationModuleClient
:undoc-members: EndpointTLSTerminationModuleClient
@@ -1,9 +0,0 @@
Webhook Validation Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_webhook_validation_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointWebhookValidationModuleClient
:undoc-members: EndpointWebhookValidationModuleClient
+9
View File
@@ -0,0 +1,9 @@
Endpoints
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoints` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointsClient
:undoc-members: EndpointsClient
-9
View File
@@ -1,9 +0,0 @@
Event Streams
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.event_streams` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EventStreamsClient
:undoc-members: EventStreamsClient
+9
View File
@@ -0,0 +1,9 @@
Failover Backends
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.failover_backends` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: FailoverBackendsClient
:undoc-members: FailoverBackendsClient
+9
View File
@@ -0,0 +1,9 @@
HTTP Response Backends
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.http_response_backends` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: HTTPResponseBackendsClient
:undoc-members: HTTPResponseBackendsClient
@@ -0,0 +1,9 @@
HTTPS Edge Mutual TLS Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.https_edge_mutual_tls_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: HTTPSEdgeMutualTLSModuleClient
:undoc-members: HTTPSEdgeMutualTLSModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge TLS Termination Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.https_edge_tls_termination_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: HTTPSEdgeTLSTerminationModuleClient
:undoc-members: HTTPSEdgeTLSTerminationModuleClient
+28 -14
View File
@@ -119,28 +119,42 @@ API Reference
abuse_reports
agent_ingresses
api_keys
failover_backends
http_response_backends
tunnel_group_backends
weighted_backends
certificate_authorities
credentials
endpoint_configurations
event_streams
edges_https_routes
edges_https
https_edge_mutual_tls_module
https_edge_tls_termination_module
edge_route_backend_module
edge_route_ip_restriction_module
edge_route_request_headers_module
edge_route_response_headers_module
edge_route_compression_module
edge_route_circuit_breaker_module
edge_route_webhook_verification_module
edge_route_o_auth_module
edge_route_saml_module
edge_route_oidc_module
edge_route_websocket_tcp_converter_module
edges_tcp
tcp_edge_backend_module
tcp_edge_ip_restriction_module
edges_tls
tls_edge_backend_module
tls_edge_ip_restriction_module
tls_edge_mutual_tls_module
tls_edge_tls_termination_module
endpoints
event_destinations
event_subscriptions
event_sources
ip_policies
ip_policy_rules
ip_restrictions
endpoint_logging_module
endpoint_circuit_breaker_module
endpoint_compression_module
endpoint_tls_termination_module
endpoint_ip_policy_module
endpoint_mutual_tls_module
endpoint_request_headers_module
endpoint_response_headers_module
endpoint_o_auth_module
endpoint_webhook_validation_module
endpoint_saml_module
endpoint_oidc_module
reserved_addrs
reserved_domains
ssh_certificate_authorities
+9
View File
@@ -0,0 +1,9 @@
TCP Edge Backend Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tcp_edge_backend_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TCPEdgeBackendModuleClient
:undoc-members: TCPEdgeBackendModuleClient
@@ -0,0 +1,9 @@
TCP Edge IP Restriction Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tcp_edge_ip_restriction_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TCPEdgeIPRestrictionModuleClient
:undoc-members: TCPEdgeIPRestrictionModuleClient
+9
View File
@@ -0,0 +1,9 @@
TLS Edge Backend Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tls_edge_backend_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TLSEdgeBackendModuleClient
:undoc-members: TLSEdgeBackendModuleClient
@@ -0,0 +1,9 @@
TLS Edge IP Restriction Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tls_edge_ip_restriction_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TLSEdgeIPRestrictionModuleClient
:undoc-members: TLSEdgeIPRestrictionModuleClient
@@ -0,0 +1,9 @@
TLS Edge Mutual TLS Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tls_edge_mutual_tls_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TLSEdgeMutualTLSModuleClient
:undoc-members: TLSEdgeMutualTLSModuleClient
@@ -0,0 +1,9 @@
TLS Edge TLS Termination Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tls_edge_tls_termination_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TLSEdgeTLSTerminationModuleClient
:undoc-members: TLSEdgeTLSTerminationModuleClient
+9
View File
@@ -0,0 +1,9 @@
Tunnel Group Backends
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tunnel_group_backends` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TunnelGroupBackendsClient
:undoc-members: TunnelGroupBackendsClient
+9
View File
@@ -0,0 +1,9 @@
Weighted Backends
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.weighted_backends` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: WeightedBackendsClient
:undoc-members: WeightedBackendsClient
+1 -1
View File
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 3f8a1ac14affc527e270aebbfc8445e3
config: de84d0462ff6d33ecc3044bd6eb7001c
tags: 645f666f9bcd5a90fca523b33c5a78b7
+29 -15
View File
@@ -118,28 +118,42 @@
<li class="toctree-l1"><a class="reference internal" href="../abuse_reports.html">Abuse Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../agent_ingresses.html">Agent Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_keys.html">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="../failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tunnel_group_backends.html">Tunnel Group Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../weighted_backends.html">Weighted Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../certificate_authorities.html">Certificate Authorities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../credentials.html">Tunnel Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_configurations.html">Endpoint Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../event_streams.html">Event Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edges_https_routes.html">HTTPS Edge Routes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edges_https.html">HTTPS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="../https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edges_tcp.html">TCP Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../edges_tls.html">TLS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints.html">Endpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="../event_destinations.html">Event Destinations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../event_subscriptions.html">Event Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../event_sources.html">Event Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ip_policies.html">IP Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ip_policy_rules.html">IP Policy Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ip_restrictions.html">IP Restrictions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_logging_module.html">Logging Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_compression_module.html">Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_tls_termination_module.html">TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_ip_policy_module.html">IP Policy Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_request_headers_module.html">Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_response_headers_module.html">Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_o_auth_module.html">OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_saml_module.html">SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../endpoint_oidc_module.html">OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reserved_addrs.html">Reserved Addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reserved_domains.html">Reserved Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
@@ -178,7 +192,7 @@
</div>
<div class="related-information">
Copyright &#169; 2021, ngrok Inc.
Copyright &#169; 1980, ngrok Inc.
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
and
+111 -49
View File
@@ -118,28 +118,42 @@
<li class="toctree-l1"><a class="reference internal" href="../../abuse_reports.html">Abuse Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../agent_ingresses.html">Agent Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../api_keys.html">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_group_backends.html">Tunnel Group Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../weighted_backends.html">Weighted Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../certificate_authorities.html">Certificate Authorities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../credentials.html">Tunnel Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_configurations.html">Endpoint Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../event_streams.html">Event Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edges_https_routes.html">HTTPS Edge Routes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edges_https.html">HTTPS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edges_tcp.html">TCP Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edges_tls.html">TLS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoints.html">Endpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../event_destinations.html">Event Destinations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../event_subscriptions.html">Event Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../event_sources.html">Event Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ip_policies.html">IP Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ip_policy_rules.html">IP Policy Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ip_restrictions.html">IP Restrictions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_logging_module.html">Logging Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_compression_module.html">Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_tls_termination_module.html">TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_ip_policy_module.html">IP Policy Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_request_headers_module.html">Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_response_headers_module.html">Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_o_auth_module.html">OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_saml_module.html">SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_oidc_module.html">OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../reserved_addrs.html">Reserved Addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../reserved_domains.html">Reserved Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
@@ -211,15 +225,11 @@
<span class="k">return</span> <span class="n">CredentialsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">endpoint_configurations</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EndpointConfigurationsClient</span><span class="p">:</span>
<span class="sd">"""Endpoint Configurations are a reusable group of modules that encapsulate how</span>
<span class="sd"> traffic to a domain or address is handled. Endpoint configurations are only</span>
<span class="sd"> applied to Domains and TCP Addresses they have been attached to."""</span>
<span class="k">return</span> <span class="n">EndpointConfigurationsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">event_streams</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EventStreamsClient</span><span class="p">:</span>
<span class="k">return</span> <span class="n">EventStreamsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">endpoints</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EndpointsClient</span><span class="p">:</span>
<span class="sd">"""Endpoints provides an API for querying the endpoint objects</span>
<span class="sd"> which define what tunnel or edge is used to serve a hostport.</span>
<span class="sd"> Only active endpoints associated with a tunnel or backend are returned."""</span>
<span class="k">return</span> <span class="n">EndpointsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">event_destinations</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EventDestinationsClient</span><span class="p">:</span>
@@ -321,35 +331,87 @@
<span class="k">return</span> <span class="n">TunnelsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">pointcfg_module</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">backends</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">ns</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span>
<span class="s2">"Namespace"</span><span class="p">,</span>
<span class="s2">"logging"</span><span class="p">,</span>
<span class="s2">"circuit_breaker"</span><span class="p">,</span>
<span class="s2">"compression"</span><span class="p">,</span>
<span class="s2">"tls_termination"</span><span class="p">,</span>
<span class="s2">"ip_policy"</span><span class="p">,</span>
<span class="s2">"mutual_tls"</span><span class="p">,</span>
<span class="s2">"request_headers"</span><span class="p">,</span>
<span class="s2">"response_headers"</span><span class="p">,</span>
<span class="s2">"oauth"</span><span class="p">,</span>
<span class="s2">"webhook_validation"</span><span class="p">,</span>
<span class="s2">"saml"</span><span class="p">,</span>
<span class="s2">"oidc"</span><span class="p">,</span>
<span class="s2">"failover"</span><span class="p">,</span>
<span class="s2">"http_response"</span><span class="p">,</span>
<span class="s2">"tunnel_group"</span><span class="p">,</span>
<span class="s2">"weighted"</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">ns</span><span class="p">(</span>
<span class="n">logging</span><span class="o">=</span><span class="n">EndpointLoggingModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">circuit_breaker</span><span class="o">=</span><span class="n">EndpointCircuitBreakerModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">compression</span><span class="o">=</span><span class="n">EndpointCompressionModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_termination</span><span class="o">=</span><span class="n">EndpointTLSTerminationModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">ip_policy</span><span class="o">=</span><span class="n">EndpointIPPolicyModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">mutual_tls</span><span class="o">=</span><span class="n">EndpointMutualTLSModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">request_headers</span><span class="o">=</span><span class="n">EndpointRequestHeadersModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">response_headers</span><span class="o">=</span><span class="n">EndpointResponseHeadersModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">oauth</span><span class="o">=</span><span class="n">EndpointOAuthModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">webhook_validation</span><span class="o">=</span><span class="n">EndpointWebhookValidationModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">saml</span><span class="o">=</span><span class="n">EndpointSAMLModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">oidc</span><span class="o">=</span><span class="n">EndpointOIDCModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">failover</span><span class="o">=</span><span class="n">FailoverBackendsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">http_response</span><span class="o">=</span><span class="n">HTTPResponseBackendsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tunnel_group</span><span class="o">=</span><span class="n">TunnelGroupBackendsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">weighted</span><span class="o">=</span><span class="n">WeightedBackendsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">edges</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">ns</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span>
<span class="s2">"Namespace"</span><span class="p">,</span>
<span class="s2">"https_routes"</span><span class="p">,</span>
<span class="s2">"https"</span><span class="p">,</span>
<span class="s2">"tcp"</span><span class="p">,</span>
<span class="s2">"tls"</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">ns</span><span class="p">(</span>
<span class="n">https_routes</span><span class="o">=</span><span class="n">EdgesHTTPSRoutesClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https</span><span class="o">=</span><span class="n">EdgesHTTPSClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tcp</span><span class="o">=</span><span class="n">EdgesTCPClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls</span><span class="o">=</span><span class="n">EdgesTLSClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">edge_modules</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">ns</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span>
<span class="s2">"Namespace"</span><span class="p">,</span>
<span class="s2">"https_edge_mutual_tls"</span><span class="p">,</span>
<span class="s2">"https_edge_tls_termination"</span><span class="p">,</span>
<span class="s2">"https_edge_route_backend"</span><span class="p">,</span>
<span class="s2">"https_edge_route_ip_restriction"</span><span class="p">,</span>
<span class="s2">"https_edge_route_request_headers"</span><span class="p">,</span>
<span class="s2">"https_edge_route_response_headers"</span><span class="p">,</span>
<span class="s2">"https_edge_route_compression"</span><span class="p">,</span>
<span class="s2">"https_edge_route_circuit_breaker"</span><span class="p">,</span>
<span class="s2">"https_edge_route_webhook_verification"</span><span class="p">,</span>
<span class="s2">"https_edge_route_oauth"</span><span class="p">,</span>
<span class="s2">"https_edge_route_saml"</span><span class="p">,</span>
<span class="s2">"https_edge_route_oidc"</span><span class="p">,</span>
<span class="s2">"https_edge_route_websocket_tcp_converter"</span><span class="p">,</span>
<span class="s2">"tcp_edge_backend"</span><span class="p">,</span>
<span class="s2">"tcp_edge_ip_restriction"</span><span class="p">,</span>
<span class="s2">"tls_edge_backend"</span><span class="p">,</span>
<span class="s2">"tls_edge_ip_restriction"</span><span class="p">,</span>
<span class="s2">"tls_edge_mutual_tls"</span><span class="p">,</span>
<span class="s2">"tls_edge_tls_termination"</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">ns</span><span class="p">(</span>
<span class="n">https_edge_mutual_tls</span><span class="o">=</span><span class="n">HTTPSEdgeMutualTLSModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_tls_termination</span><span class="o">=</span><span class="n">HTTPSEdgeTLSTerminationModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_route_backend</span><span class="o">=</span><span class="n">EdgeRouteBackendModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_route_ip_restriction</span><span class="o">=</span><span class="n">EdgeRouteIPRestrictionModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_route_request_headers</span><span class="o">=</span><span class="n">EdgeRouteRequestHeadersModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_route_response_headers</span><span class="o">=</span><span class="n">EdgeRouteResponseHeadersModuleClient</span><span class="p">(</span>
<span class="bp">self</span>
<span class="p">),</span>
<span class="n">https_edge_route_compression</span><span class="o">=</span><span class="n">EdgeRouteCompressionModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_route_circuit_breaker</span><span class="o">=</span><span class="n">EdgeRouteCircuitBreakerModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_route_webhook_verification</span><span class="o">=</span><span class="n">EdgeRouteWebhookVerificationModuleClient</span><span class="p">(</span>
<span class="bp">self</span>
<span class="p">),</span>
<span class="n">https_edge_route_oauth</span><span class="o">=</span><span class="n">EdgeRouteOAuthModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_route_saml</span><span class="o">=</span><span class="n">EdgeRouteSAMLModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_route_oidc</span><span class="o">=</span><span class="n">EdgeRouteOIDCModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">https_edge_route_websocket_tcp_converter</span><span class="o">=</span><span class="n">EdgeRouteWebsocketTCPConverterModuleClient</span><span class="p">(</span>
<span class="bp">self</span>
<span class="p">),</span>
<span class="n">tcp_edge_backend</span><span class="o">=</span><span class="n">TCPEdgeBackendModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tcp_edge_ip_restriction</span><span class="o">=</span><span class="n">TCPEdgeIPRestrictionModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_edge_backend</span><span class="o">=</span><span class="n">TLSEdgeBackendModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_edge_ip_restriction</span><span class="o">=</span><span class="n">TLSEdgeIPRestrictionModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_edge_mutual_tls</span><span class="o">=</span><span class="n">TLSEdgeMutualTLSModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_edge_tls_termination</span><span class="o">=</span><span class="n">TLSEdgeTLSTerminationModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="p">)</span></div>
</pre></div>
</article>
@@ -361,7 +423,7 @@
</div>
<div class="related-information">
Copyright &#169; 2021, ngrok Inc.
Copyright &#169; 1980, ngrok Inc.
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
and
File diff suppressed because it is too large. Load diff
+29 -15
View File
@@ -118,28 +118,42 @@
<li class="toctree-l1"><a class="reference internal" href="../../abuse_reports.html">Abuse Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../agent_ingresses.html">Agent Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../api_keys.html">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_group_backends.html">Tunnel Group Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../weighted_backends.html">Weighted Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../certificate_authorities.html">Certificate Authorities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../credentials.html">Tunnel Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_configurations.html">Endpoint Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../event_streams.html">Event Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edges_https_routes.html">HTTPS Edge Routes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edges_https.html">HTTPS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edges_tcp.html">TCP Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../edges_tls.html">TLS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoints.html">Endpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../event_destinations.html">Event Destinations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../event_subscriptions.html">Event Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../event_sources.html">Event Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ip_policies.html">IP Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ip_policy_rules.html">IP Policy Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ip_restrictions.html">IP Restrictions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_logging_module.html">Logging Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_compression_module.html">Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_tls_termination_module.html">TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_ip_policy_module.html">IP Policy Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_request_headers_module.html">Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_response_headers_module.html">Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_o_auth_module.html">OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_saml_module.html">SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_oidc_module.html">OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../reserved_addrs.html">Reserved Addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../reserved_domains.html">Reserved Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
@@ -216,7 +230,7 @@
</div>
<div class="related-information">
Copyright &#169; 2021, ngrok Inc.
Copyright &#169; 1980, ngrok Inc.
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
and
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,9 @@
HTTPS Edge Route Backend Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_backend_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteBackendModuleClient
:undoc-members: EdgeRouteBackendModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Circuit Breaker Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_circuit_breaker_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteCircuitBreakerModuleClient
:undoc-members: EdgeRouteCircuitBreakerModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Compression Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_compression_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteCompressionModuleClient
:undoc-members: EdgeRouteCompressionModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route IP Restriction Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_ip_restriction_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteIPRestrictionModuleClient
:undoc-members: EdgeRouteIPRestrictionModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route OAuth Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_o_auth_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteOAuthModuleClient
:undoc-members: EdgeRouteOAuthModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route OIDC Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_oidc_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteOIDCModuleClient
:undoc-members: EdgeRouteOIDCModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Request Headers Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_request_headers_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteRequestHeadersModuleClient
:undoc-members: EdgeRouteRequestHeadersModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Response Headers Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_response_headers_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteResponseHeadersModuleClient
:undoc-members: EdgeRouteResponseHeadersModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route SAML Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_saml_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteSAMLModuleClient
:undoc-members: EdgeRouteSAMLModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Webhook Verification Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_webhook_verification_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteWebhookVerificationModuleClient
:undoc-members: EdgeRouteWebhookVerificationModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge Route Websocket TCP Converter Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edge_route_websocket_tcp_converter_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgeRouteWebsocketTCPConverterModuleClient
:undoc-members: EdgeRouteWebsocketTCPConverterModuleClient
+9
View File
@@ -0,0 +1,9 @@
HTTPS Edges
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edges_https` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgesHTTPSClient
:undoc-members: EdgesHTTPSClient
+9
View File
@@ -0,0 +1,9 @@
HTTPS Edge Routes
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edges_https_routes` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgesHTTPSRoutesClient
:undoc-members: EdgesHTTPSRoutesClient
+9
View File
@@ -0,0 +1,9 @@
TCP Edges
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edges_tcp` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgesTCPClient
:undoc-members: EdgesTCPClient
+9
View File
@@ -0,0 +1,9 @@
TLS Edges
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.edges_tls` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EdgesTLSClient
:undoc-members: EdgesTLSClient
@@ -1,9 +0,0 @@
Circuit Breaker Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_circuit_breaker_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointCircuitBreakerModuleClient
:undoc-members: EndpointCircuitBreakerModuleClient
@@ -1,9 +0,0 @@
Compression Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_compression_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointCompressionModuleClient
:undoc-members: EndpointCompressionModuleClient
@@ -1,9 +0,0 @@
Endpoint Configurations
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_configurations` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointConfigurationsClient
:undoc-members: EndpointConfigurationsClient
@@ -1,9 +0,0 @@
IP Policy Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_ip_policy_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointIPPolicyModuleClient
:undoc-members: EndpointIPPolicyModuleClient
@@ -1,9 +0,0 @@
Logging Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_logging_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointLoggingModuleClient
:undoc-members: EndpointLoggingModuleClient
@@ -1,9 +0,0 @@
Mutual TLS Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_mutual_tls_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointMutualTLSModuleClient
:undoc-members: EndpointMutualTLSModuleClient
@@ -1,9 +0,0 @@
OAuth Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_o_auth_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointOAuthModuleClient
:undoc-members: EndpointOAuthModuleClient
@@ -1,9 +0,0 @@
OIDC Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_oidc_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointOIDCModuleClient
:undoc-members: EndpointOIDCModuleClient
@@ -1,9 +0,0 @@
Request Headers Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_request_headers_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointRequestHeadersModuleClient
:undoc-members: EndpointRequestHeadersModuleClient
@@ -1,9 +0,0 @@
Response Headers Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_response_headers_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointResponseHeadersModuleClient
:undoc-members: EndpointResponseHeadersModuleClient
@@ -1,9 +0,0 @@
SAML Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_saml_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointSAMLModuleClient
:undoc-members: EndpointSAMLModuleClient
@@ -1,9 +0,0 @@
TLS Termination Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_tls_termination_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointTLSTerminationModuleClient
:undoc-members: EndpointTLSTerminationModuleClient
@@ -1,9 +0,0 @@
Webhook Validation Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoint_webhook_validation_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointWebhookValidationModuleClient
:undoc-members: EndpointWebhookValidationModuleClient
+9
View File
@@ -0,0 +1,9 @@
Endpoints
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.endpoints` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EndpointsClient
:undoc-members: EndpointsClient
-9
View File
@@ -1,9 +0,0 @@
Event Streams
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.event_streams` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: EventStreamsClient
:undoc-members: EventStreamsClient
+9
View File
@@ -0,0 +1,9 @@
Failover Backends
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.failover_backends` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: FailoverBackendsClient
:undoc-members: FailoverBackendsClient
@@ -0,0 +1,9 @@
HTTP Response Backends
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.http_response_backends` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: HTTPResponseBackendsClient
:undoc-members: HTTPResponseBackendsClient
@@ -0,0 +1,9 @@
HTTPS Edge Mutual TLS Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.https_edge_mutual_tls_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: HTTPSEdgeMutualTLSModuleClient
:undoc-members: HTTPSEdgeMutualTLSModuleClient
@@ -0,0 +1,9 @@
HTTPS Edge TLS Termination Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.https_edge_tls_termination_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: HTTPSEdgeTLSTerminationModuleClient
:undoc-members: HTTPSEdgeTLSTerminationModuleClient
+28 -14
View File
@@ -119,28 +119,42 @@ API Reference
abuse_reports
agent_ingresses
api_keys
failover_backends
http_response_backends
tunnel_group_backends
weighted_backends
certificate_authorities
credentials
endpoint_configurations
event_streams
edges_https_routes
edges_https
https_edge_mutual_tls_module
https_edge_tls_termination_module
edge_route_backend_module
edge_route_ip_restriction_module
edge_route_request_headers_module
edge_route_response_headers_module
edge_route_compression_module
edge_route_circuit_breaker_module
edge_route_webhook_verification_module
edge_route_o_auth_module
edge_route_saml_module
edge_route_oidc_module
edge_route_websocket_tcp_converter_module
edges_tcp
tcp_edge_backend_module
tcp_edge_ip_restriction_module
edges_tls
tls_edge_backend_module
tls_edge_ip_restriction_module
tls_edge_mutual_tls_module
tls_edge_tls_termination_module
endpoints
event_destinations
event_subscriptions
event_sources
ip_policies
ip_policy_rules
ip_restrictions
endpoint_logging_module
endpoint_circuit_breaker_module
endpoint_compression_module
endpoint_tls_termination_module
endpoint_ip_policy_module
endpoint_mutual_tls_module
endpoint_request_headers_module
endpoint_response_headers_module
endpoint_o_auth_module
endpoint_webhook_validation_module
endpoint_saml_module
endpoint_oidc_module
reserved_addrs
reserved_domains
ssh_certificate_authorities
@@ -0,0 +1,9 @@
TCP Edge Backend Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tcp_edge_backend_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TCPEdgeBackendModuleClient
:undoc-members: TCPEdgeBackendModuleClient
@@ -0,0 +1,9 @@
TCP Edge IP Restriction Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tcp_edge_ip_restriction_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TCPEdgeIPRestrictionModuleClient
:undoc-members: TCPEdgeIPRestrictionModuleClient
@@ -0,0 +1,9 @@
TLS Edge Backend Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tls_edge_backend_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TLSEdgeBackendModuleClient
:undoc-members: TLSEdgeBackendModuleClient
@@ -0,0 +1,9 @@
TLS Edge IP Restriction Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tls_edge_ip_restriction_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TLSEdgeIPRestrictionModuleClient
:undoc-members: TLSEdgeIPRestrictionModuleClient
@@ -0,0 +1,9 @@
TLS Edge Mutual TLS Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tls_edge_mutual_tls_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TLSEdgeMutualTLSModuleClient
:undoc-members: TLSEdgeMutualTLSModuleClient
@@ -0,0 +1,9 @@
TLS Edge TLS Termination Module
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tls_edge_tls_termination_module` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TLSEdgeTLSTerminationModuleClient
:undoc-members: TLSEdgeTLSTerminationModuleClient
@@ -0,0 +1,9 @@
Tunnel Group Backends
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.tunnel_group_backends` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: TunnelGroupBackendsClient
:undoc-members: TunnelGroupBackendsClient
+9
View File
@@ -0,0 +1,9 @@
Weighted Backends
=====================================
Do not construct this object directly, instead access the
:attr:`~ngrok.Client.weighted_backends` property of an :class:`ngrok.Client` object.
.. automodule:: ngrok.services
:members: WeightedBackendsClient
:undoc-members: WeightedBackendsClient
+17 -17
View File
@@ -5,22 +5,22 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #408080; font-style: italic } /* Comment */
.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #9C6500 } /* Comment.Preproc */
.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gr { color: #E40000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gi { color: #008400 } /* Generic.Inserted */
.highlight .go { color: #717171 } /* Generic.Output */
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
@@ -33,15 +33,15 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .m { color: #666666 } /* Literal.Number */
.highlight .s { color: #BA2121 } /* Literal.String */
.highlight .na { color: #7D9029 } /* Name.Attribute */
.highlight .na { color: #687822 } /* Name.Attribute */
.highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.highlight .no { color: #880000 } /* Name.Constant */
.highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0000FF } /* Name.Function */
.highlight .nl { color: #A0A000 } /* Name.Label */
.highlight .nl { color: #767600 } /* Name.Label */
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #19177C } /* Name.Variable */
@@ -58,11 +58,11 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
.highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
.highlight .sr { color: #A45A77 } /* Literal.String.Regex */
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
+29 -15
View File
@@ -118,28 +118,42 @@
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Abuse Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_tls_termination_module.html">TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_ip_policy_module.html">IP Policy Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_request_headers_module.html">Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_response_headers_module.html">Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_o_auth_module.html">OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_saml_module.html">SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_oidc_module.html">OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
@@ -237,7 +251,7 @@ ngrok that violate ngrok’s terms of service.</p>
</div>
<div class="related-information">
Copyright &#169; 2021, ngrok Inc.
Copyright &#169; 1980, ngrok Inc.
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
and
+29 -15
View File
@@ -118,28 +118,42 @@
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Agent Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_tls_termination_module.html">TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_ip_policy_module.html">IP Policy Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_request_headers_module.html">Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_response_headers_module.html">Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_o_auth_module.html">OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_saml_module.html">SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_oidc_module.html">OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
@@ -286,7 +300,7 @@
</div>
<div class="related-information">
Copyright &#169; 2021, ngrok Inc.
Copyright &#169; 1980, ngrok Inc.
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
and
+32 -18
View File
@@ -2,7 +2,7 @@
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Certificate Authorities" href="certificate_authorities.html" /><link rel="prev" title="Agent Ingresses" href="agent_ingresses.html" />
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Failover Backends" href="failover_backends.html" /><link rel="prev" title="Agent Ingresses" href="agent_ingresses.html" />
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
<title>API Keys - ngrok-api documentation</title>
@@ -118,28 +118,42 @@
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_tls_termination_module.html">TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_ip_policy_module.html">IP Policy Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_request_headers_module.html">Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_response_headers_module.html">Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_o_auth_module.html">OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_saml_module.html">SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_oidc_module.html">OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
@@ -267,12 +281,12 @@ ngrok.com dashboard.</p>
<footer>
<div class="related-pages">
<a class="next-page" href="certificate_authorities.html">
<a class="next-page" href="failover_backends.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Certificate Authorities</div>
<div class="title">Failover Backends</div>
</div>
<svg><use href="#svg-arrow-right"></use></svg>
</a>
@@ -290,7 +304,7 @@ ngrok.com dashboard.</p>
</div>
<div class="related-information">
Copyright &#169; 2021, ngrok Inc.
Copyright &#169; 1980, ngrok Inc.
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
and
+32 -18
View File
@@ -2,7 +2,7 @@
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Tunnel Credentials" href="credentials.html" /><link rel="prev" title="API Keys" href="api_keys.html" />
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Tunnel Credentials" href="credentials.html" /><link rel="prev" title="Weighted Backends" href="weighted_backends.html" />
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
<title>Certificate Authorities - ngrok-api documentation</title>
@@ -118,28 +118,42 @@
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Certificate Authorities</a></li>
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_tls_termination_module.html">TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_ip_policy_module.html">IP Policy Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_request_headers_module.html">Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_response_headers_module.html">Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_o_auth_module.html">OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_saml_module.html">SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_oidc_module.html">OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
@@ -277,21 +291,21 @@ thus a private key is not included in the resource.</p>
</div>
<svg><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="api_keys.html">
<a class="prev-page" href="weighted_backends.html">
<svg><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">API Keys</div>
<div class="title">Weighted Backends</div>
</div>
</a>
</div>
<div class="related-information">
Copyright &#169; 2021, ngrok Inc.
Copyright &#169; 1980, ngrok Inc.
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
and
+47 -34
View File
@@ -118,28 +118,42 @@
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_tls_termination_module.html">TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_ip_policy_module.html">IP Policy Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_request_headers_module.html">Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_response_headers_module.html">Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_o_auth_module.html">OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_saml_module.html">SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_oidc_module.html">OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
@@ -220,6 +234,10 @@ ngrok.com dashboard.</p>
</dl>
</dd></dl>
<dl class="py method">
<dt id="ngrok.Client.backends">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">backends</span></code><a class="headerlink" href="#ngrok.Client.backends" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="ngrok.Client.certificate_authorities">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate_authorities</span></code><a class="headerlink" href="#ngrok.Client.certificate_authorities" title="Permalink to this definition"></a></dt>
<dd><p>Certificate Authorities are x509 certificates that are used to sign other
@@ -247,14 +265,22 @@ configuration file with the <code class="docutils literal notranslate"><span cla
</dl>
</dd></dl>
<dl class="py method">
<dt id="ngrok.Client.endpoint_configurations">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">endpoint_configurations</span></code><a class="headerlink" href="#ngrok.Client.endpoint_configurations" title="Permalink to this definition"></a></dt>
<dd><p>Endpoint Configurations are a reusable group of modules that encapsulate how
traffic to a domain or address is handled. Endpoint configurations are only
applied to Domains and TCP Addresses they have been attached to.</p>
<dt id="ngrok.Client.edge_modules">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">edge_modules</span></code><a class="headerlink" href="#ngrok.Client.edge_modules" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="ngrok.Client.edges">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">edges</span></code><a class="headerlink" href="#ngrok.Client.edges" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="ngrok.Client.endpoints">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">endpoints</span></code><a class="headerlink" href="#ngrok.Client.endpoints" title="Permalink to this definition"></a></dt>
<dd><p>Endpoints provides an API for querying the endpoint objects
which define what tunnel or edge is used to serve a hostport.
Only active endpoints associated with a tunnel or backend are returned.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient" title="ngrok.services.EndpointConfigurationsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfigurationsClient</span></code></a></p>
<dd class="field-odd"><p><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient" title="ngrok.services.EndpointsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointsClient</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -277,15 +303,6 @@ applied to Domains and TCP Addresses they have been attached to.</p>
</dl>
</dd></dl>
<dl class="py method">
<dt id="ngrok.Client.event_streams">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_streams</span></code><a class="headerlink" href="#ngrok.Client.event_streams" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="event_streams.html#ngrok.services.EventStreamsClient" title="ngrok.services.EventStreamsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStreamsClient</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="ngrok.Client.event_subscriptions">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_subscriptions</span></code><a class="headerlink" href="#ngrok.Client.event_subscriptions" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
@@ -334,10 +351,6 @@ public-facing endpoints.</p>
</dl>
</dd></dl>
<dl class="py method">
<dt id="ngrok.Client.pointcfg_module">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">pointcfg_module</span></code><a class="headerlink" href="#ngrok.Client.pointcfg_module" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="ngrok.Client.reserved_addrs">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">reserved_addrs</span></code><a class="headerlink" href="#ngrok.Client.reserved_addrs" title="Permalink to this definition"></a></dt>
<dd><p>Reserved Addresses are TCP addresses that can be used to listen for traffic.
@@ -475,7 +488,7 @@ agent tunnel session or an SSH reverse tunnel session.</p>
</div>
<div class="related-information">
Copyright &#169; 2021, ngrok Inc.
Copyright &#169; 1980, ngrok Inc.
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
and
+32 -18
View File
@@ -2,7 +2,7 @@
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Endpoint Configurations" href="endpoint_configurations.html" /><link rel="prev" title="Certificate Authorities" href="certificate_authorities.html" />
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Routes" href="edges_https_routes.html" /><link rel="prev" title="Certificate Authorities" href="certificate_authorities.html" />
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
<title>Tunnel Credentials - ngrok-api documentation</title>
@@ -118,28 +118,42 @@
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Tunnel Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_tls_termination_module.html">TLS Termination Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_ip_policy_module.html">IP Policy Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_request_headers_module.html">Request Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_response_headers_module.html">Response Headers Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_o_auth_module.html">OAuth Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_saml_module.html">SAML Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="endpoint_oidc_module.html">OIDC Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
@@ -268,12 +282,12 @@ configuration file with the <code class="docutils literal notranslate"><span cla
<footer>
<div class="related-pages">
<a class="next-page" href="endpoint_configurations.html">
<a class="next-page" href="edges_https_routes.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Endpoint Configurations</div>
<div class="title">HTTPS Edge Routes</div>
</div>
<svg><use href="#svg-arrow-right"></use></svg>
</a>
@@ -291,7 +305,7 @@ configuration file with the <code class="docutils literal notranslate"><span cla
</div>
<div class="related-information">
Copyright &#169; 2021, ngrok Inc.
Copyright &#169; 1980, ngrok Inc.
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
and
+1365 -443
View File
File diff suppressed because it is too large. Load diff
Loaded 100 of 157 files, more files were not shown because too many files have changed in this diff. Show more