mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-05-17 16:50:36 +00:00
Update generated files
This commit is contained in:
ngrok release bot
Vendored
BIN
Binary file not shown.
+20
-20
@@ -1,6 +1,6 @@
|
||||
action: GLOB, msg: packaging
|
||||
cwd: /var/lib/buildkite-agent-4/builds/ip-172-31-53-232-us-west-2-compute-internal-4-1/ngrok/api-client-prs/.cache/ngrok-api-python
|
||||
cmd: /var/lib/buildkite-agent-4/builds/ip-172-31-53-232-us-west-2-compute-internal-4-1/ngrok/api-client-prs/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir .tox/dist
|
||||
cwd: /var/lib/buildkite-agent-9/builds/ip-172-31-29-111-us-west-2-compute-internal-9-1/ngrok/api-client-prs/.cache/ngrok-api-python
|
||||
cmd: /var/lib/buildkite-agent-9/builds/ip-172-31-29-111-us-west-2-compute-internal-9-1/ngrok/api-client-prs/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir .tox/dist
|
||||
running sdist
|
||||
running egg_info
|
||||
writing ngrok_api.egg-info/PKG-INFO
|
||||
@@ -37,27 +37,27 @@ copying tests/test_ngrok.py -> ngrok-api-0.0.0/tests
|
||||
Writing ngrok-api-0.0.0/setup.cfg
|
||||
creating '.tox/dist/ngrok-api-0.0.0.zip' and adding 'ngrok-api-0.0.0' to it
|
||||
adding 'ngrok-api-0.0.0'
|
||||
adding 'ngrok-api-0.0.0/tests'
|
||||
adding 'ngrok-api-0.0.0/ngrok'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info'
|
||||
adding 'ngrok-api-0.0.0/README.md'
|
||||
adding 'ngrok-api-0.0.0/pyproject.toml'
|
||||
adding 'ngrok-api-0.0.0/setup.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok'
|
||||
adding 'ngrok-api-0.0.0/tests'
|
||||
adding 'ngrok-api-0.0.0/setup.cfg'
|
||||
adding 'ngrok-api-0.0.0/LICENSE'
|
||||
adding 'ngrok-api-0.0.0/PKG-INFO'
|
||||
adding 'ngrok-api-0.0.0/tests/test_ngrok.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/utils.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/client.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/http_client.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/datatypes.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/iterator.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/__init__.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/services.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/error.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/SOURCES.txt'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/requires.txt'
|
||||
adding 'ngrok-api-0.0.0/pyproject.toml'
|
||||
adding 'ngrok-api-0.0.0/README.md'
|
||||
adding 'ngrok-api-0.0.0/LICENSE'
|
||||
adding 'ngrok-api-0.0.0/setup.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/dependency_links.txt'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/top_level.txt'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/PKG-INFO'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/top_level.txt'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/requires.txt'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/SOURCES.txt'
|
||||
adding 'ngrok-api-0.0.0/ngrok/client.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/utils.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/datatypes.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/http_client.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/services.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/__init__.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/iterator.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/error.py'
|
||||
adding 'ngrok-api-0.0.0/tests/test_ngrok.py'
|
||||
removing 'ngrok-api-0.0.0' (and everything under it)
|
||||
|
||||
+4
-1
@@ -1,9 +1,12 @@
|
||||
<!-- Code generated for API Clients. DO NOT EDIT. -->
|
||||
|
||||
## 0.11.0
|
||||
|
||||
* Added support for the Bot User API. The Bot User API allows you to manage the bots that are registered to your ngrok account. You can automate the creation, management, and deletion of bot users in your account.
|
||||
|
||||
## 0.10.0
|
||||
|
||||
ENHANCEMENTS:
|
||||
|
||||
* Added `owner_id` field to the `api_key`, `credential`, and `ssh_credential` resources. If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
|
||||
* Added `failover_backend`, `http_response_backend`, and `tunnel_group_backend` resources. A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Bot Users
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.bot_users` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: BotUsersClient
|
||||
:undoc-members: BotUsersClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
HTTPS Edge Route Policies Module
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.edge_route_policy_module` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: EdgeRoutePolicyModuleClient
|
||||
:undoc-members: EdgeRoutePolicyModuleClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
HTTPS Edge Route User Agent Filter Module
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.edge_route_user_agent_filter_module` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: EdgeRouteUserAgentFilterModuleClient
|
||||
:undoc-members: EdgeRouteUserAgentFilterModuleClient
|
||||
@@ -131,8 +131,10 @@ API Reference
|
||||
tunnel_sessions
|
||||
failover_backends
|
||||
http_response_backends
|
||||
static_backends
|
||||
tunnel_group_backends
|
||||
weighted_backends
|
||||
bot_users
|
||||
certificate_authorities
|
||||
credentials
|
||||
edges_https_routes
|
||||
@@ -150,14 +152,18 @@ API Reference
|
||||
edge_route_saml_module
|
||||
edge_route_oidc_module
|
||||
edge_route_websocket_tcp_converter_module
|
||||
edge_route_user_agent_filter_module
|
||||
edge_route_policy_module
|
||||
edges_tcp
|
||||
tcp_edge_backend_module
|
||||
tcp_edge_ip_restriction_module
|
||||
tcp_edge_policy_module
|
||||
edges_tls
|
||||
tls_edge_backend_module
|
||||
tls_edge_ip_restriction_module
|
||||
tls_edge_mutual_tls_module
|
||||
tls_edge_tls_termination_module
|
||||
tls_edge_policy_module
|
||||
endpoints
|
||||
event_destinations
|
||||
event_subscriptions
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Static Backends
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.static_backends` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: StaticBackendsClient
|
||||
:undoc-members: StaticBackendsClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
TCP Edge Policy Module
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.tcp_edge_policy_module` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: TCPEdgePolicyModuleClient
|
||||
:undoc-members: TCPEdgePolicyModuleClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
TLS Edge Policy Module
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.tls_edge_policy_module` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: TLSEdgePolicyModuleClient
|
||||
:undoc-members: TLSEdgePolicyModuleClient
|
||||
@@ -169,8 +169,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../tunnel_sessions.html">Tunnel Sessions</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="../static_backends.html">Static 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="../bot_users.html">Bot Users</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="../edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -188,14 +190,18 @@
|
||||
<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="../edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../edge_route_policy_module.html">HTTPS Edge Route Policies 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="../tcp_edge_policy_module.html">TCP Edge Policy 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="../tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
|
||||
@@ -169,8 +169,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_sessions.html">Tunnel Sessions</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="../../static_backends.html">Static 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="../../bot_users.html">Bot Users</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="../../edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -188,14 +190,18 @@
|
||||
<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="../../edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_policy_module.html">HTTPS Edge Route Policies 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="../../tcp_edge_policy_module.html">TCP Edge Policy 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="../../tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -292,6 +298,10 @@
|
||||
<span class="sd"> session can include one or more Tunnels."""</span>
|
||||
<span class="k">return</span> <span class="n">TunnelSessionsClient</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">bot_users</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">BotUsersClient</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">BotUsersClient</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">certificate_authorities</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">CertificateAuthoritiesClient</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Certificate Authorities are x509 certificates that are used to sign other</span>
|
||||
@@ -415,6 +425,7 @@
|
||||
<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">"static_address"</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>
|
||||
@@ -422,6 +433,7 @@
|
||||
<span class="k">return</span> <span class="n">ns</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">static_address</span><span class="o">=</span><span class="n">StaticBackendsClient</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>
|
||||
@@ -462,6 +474,7 @@
|
||||
<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">"https_edge_route_user_agent_filter"</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>
|
||||
@@ -490,6 +503,9 @@
|
||||
<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">https_edge_route_user_agent_filter</span><span class="o">=</span><span class="n">EdgeRouteUserAgentFilterModuleClient</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>
|
||||
|
||||
@@ -169,8 +169,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_sessions.html">Tunnel Sessions</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="../../static_backends.html">Static 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="../../bot_users.html">Bot Users</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="../../edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -188,14 +190,18 @@
|
||||
<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="../../edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_policy_module.html">HTTPS Edge Route Policies 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="../../tcp_edge_policy_module.html">TCP Edge Policy 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="../../tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -1408,6 +1414,141 @@
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"next_page_uri"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="StaticBackend"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.StaticBackend">[docs]</a><span class="k">class</span> <span class="nc">StaticBackend</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"tls"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="n">StaticBackendTLS</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">"tls"</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"tls"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<StaticBackend </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<StaticBackend </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<div class="viewcode-block" id="StaticBackend.delete"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.StaticBackend.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">static_address</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StaticBackend.update"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.StaticBackend.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">address</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">tls</span><span class="p">:</span> <span class="n">StaticBackendTLS</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">static_address</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
||||
<span class="n">address</span><span class="o">=</span><span class="n">address</span><span class="p">,</span>
|
||||
<span class="n">tls</span><span class="o">=</span><span class="n">tls</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""unique identifier for this static backend"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"id"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the StaticBackend API resource"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">created_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""timestamp when the backend was created, RFC 3339 format"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"created_at"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""human-readable description of this backend. Optional"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""arbitrary user-defined machine-readable data of this backend. Optional"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"metadata"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">address</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""the address to forward to"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"address"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">tls</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">StaticBackendTLS</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""tls configuration to use"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"tls"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="StaticBackendTLS"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.StaticBackendTLS">[docs]</a><span class="k">class</span> <span class="nc">StaticBackendTLS</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<StaticBackendTLS </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<StaticBackendTLS </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""if TLS is checked"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"enabled"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="StaticBackendList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.StaticBackendList">[docs]</a><span class="k">class</span> <span class="nc">StaticBackendList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"backends"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="p">[</span><span class="n">StaticBackend</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">"backends"</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"backends"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="p">[]</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<StaticBackendList </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<StaticBackendList </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">PagedIterator</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">"backends"</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</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="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="n">StaticBackend</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""the list of all static backends on this account"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"backends"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the static backends list API resource"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">next_page_uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the next page, or null if there is no next page"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"next_page_uri"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="TunnelGroupBackend"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.TunnelGroupBackend">[docs]</a><span class="k">class</span> <span class="nc">TunnelGroupBackend</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
@@ -1624,6 +1765,102 @@
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"next_page_uri"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="BotUser"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.BotUser">[docs]</a><span class="k">class</span> <span class="nc">BotUser</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<BotUser </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<BotUser </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<div class="viewcode-block" id="BotUser.delete"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.BotUser.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">bot_users</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="BotUser.update"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.BotUser.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">bot_users</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="o">=</span><span class="n">active</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""unique API key resource identifier"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"id"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI to the API resource of this bot user"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""human-readable name used to identify the bot"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">active</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""whether or not the bot is active"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"active"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">created_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""timestamp when the api key was created, RFC 3339 format"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"created_at"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="BotUserList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.BotUserList">[docs]</a><span class="k">class</span> <span class="nc">BotUserList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"bot_users"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="p">[</span><span class="n">BotUser</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">"bot_users"</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bot_users"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="p">[]</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<BotUserList </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<BotUserList </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">PagedIterator</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">"bot_users"</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">bot_users</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="n">BotUser</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""the list of all bot users on this account"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"bot_users"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the bot users list API resource"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">next_page_uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the next page, or null if there is no next page"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"next_page_uri"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="CertificateAuthority"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.CertificateAuthority">[docs]</a><span class="k">class</span> <span class="nc">CertificateAuthority</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
@@ -1886,7 +2123,7 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">provider</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at `https://ngrok.com/docs/cloud-edge/modules/webhook <https://ngrok.com/docs/cloud-edge/modules/webhook>`_"""</span>
|
||||
<span class="w"> </span><span class="sd">"""a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at `https://ngrok.com/docs/cloud-edge/modules/webhook-verification <https://ngrok.com/docs/cloud-edge/modules/webhook-verification>`_"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"provider"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
@@ -2937,6 +3174,133 @@
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"enabled"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EndpointUserAgentFilter"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.EndpointUserAgentFilter">[docs]</a><span class="k">class</span> <span class="nc">EndpointUserAgentFilter</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<EndpointUserAgentFilter </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<EndpointUserAgentFilter </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"enabled"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">allow</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"allow"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">deny</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"deny"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EndpointPolicy"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.EndpointPolicy">[docs]</a><span class="k">class</span> <span class="nc">EndpointPolicy</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"inbound"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="p">[</span><span class="n">EndpointRule</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">"inbound"</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"inbound"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="p">[]</span>
|
||||
<span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"outbound"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="p">[</span><span class="n">EndpointRule</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">"outbound"</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"outbound"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="p">[]</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<EndpointPolicy </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<EndpointPolicy </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"enabled"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">inbound</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="n">EndpointRule</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""the inbound rules of the traffic policy."""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"inbound"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">outbound</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="n">EndpointRule</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""the outbound rules on the traffic policy."""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"outbound"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EndpointRule"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.EndpointRule">[docs]</a><span class="k">class</span> <span class="nc">EndpointRule</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"actions"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="p">[</span><span class="n">EndpointAction</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">"actions"</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"actions"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="p">[]</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<EndpointRule </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<EndpointRule </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">expressions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""cel expressions that filter traffic the policy rule applies to."""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"expressions"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">actions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="n">EndpointAction</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""the set of actions on a policy rule."""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"actions"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""the name of the rule that is part of the traffic policy."""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EndpointAction"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.EndpointAction">[docs]</a><span class="k">class</span> <span class="nc">EndpointAction</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<EndpointAction </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<EndpointAction </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""the type of action on the policy rule."""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"type"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">config</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">object</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""the configuration for the action on the policy rule."""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"config"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="HTTPSEdgeRoute"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.HTTPSEdgeRoute">[docs]</a><span class="k">class</span> <span class="nc">HTTPSEdgeRoute</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
@@ -2996,6 +3360,16 @@
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"websocket_tcp_converter"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"user_agent_filter"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="n">EndpointUserAgentFilter</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">"user_agent_filter"</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"user_agent_filter"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"policy"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="n">EndpointPolicy</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">"policy"</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"policy"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
@@ -3023,6 +3397,8 @@
|
||||
<span class="n">saml</span><span class="p">:</span> <span class="n">EndpointSAMLMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">oidc</span><span class="p">:</span> <span class="n">EndpointOIDC</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">websocket_tcp_converter</span><span class="p">:</span> <span class="n">EndpointWebsocketTCPConverter</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">user_agent_filter</span><span class="p">:</span> <span class="n">EndpointUserAgentFilter</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">edges</span><span class="o">.</span><span class="n">https_routes</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
|
||||
<span class="n">edge_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">edge_id</span><span class="p">,</span>
|
||||
@@ -3042,6 +3418,8 @@
|
||||
<span class="n">saml</span><span class="o">=</span><span class="n">saml</span><span class="p">,</span>
|
||||
<span class="n">oidc</span><span class="o">=</span><span class="n">oidc</span><span class="p">,</span>
|
||||
<span class="n">websocket_tcp_converter</span><span class="o">=</span><span class="n">websocket_tcp_converter</span><span class="p">,</span>
|
||||
<span class="n">user_agent_filter</span><span class="o">=</span><span class="n">user_agent_filter</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="o">=</span><span class="n">policy</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="HTTPSEdgeRoute.delete"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
@@ -3145,7 +3523,16 @@
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">websocket_tcp_converter</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointWebsocketTCPConverter</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""websocket to tcp adapter configuration or ``null``"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"websocket_tcp_converter"</span><span class="p">]</span></div>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"websocket_tcp_converter"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">user_agent_filter</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointUserAgentFilter</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"user_agent_filter"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">policy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointPolicy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""the traffic policy associated with this edge or null"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"policy"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="HTTPSEdgeList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.HTTPSEdgeList">[docs]</a><span class="k">class</span> <span class="nc">HTTPSEdgeList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
@@ -3336,6 +3723,11 @@
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"ip_restriction"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"policy"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="n">EndpointPolicy</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">"policy"</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"policy"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
@@ -3353,6 +3745,7 @@
|
||||
<span class="n">hostports</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">backend</span><span class="p">:</span> <span class="n">EndpointBackendMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">ip_restriction</span><span class="p">:</span> <span class="n">EndpointIPPolicyMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">edges</span><span class="o">.</span><span class="n">tcp</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
@@ -3361,6 +3754,7 @@
|
||||
<span class="n">hostports</span><span class="o">=</span><span class="n">hostports</span><span class="p">,</span>
|
||||
<span class="n">backend</span><span class="o">=</span><span class="n">backend</span><span class="p">,</span>
|
||||
<span class="n">ip_restriction</span><span class="o">=</span><span class="n">ip_restriction</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="o">=</span><span class="n">policy</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TCPEdge.delete"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.TCPEdge.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
@@ -3407,7 +3801,12 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">ip_restriction</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointIPPolicy</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"ip_restriction"</span><span class="p">]</span></div>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"ip_restriction"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">policy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointPolicy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""the traffic policy associated with this edge or null"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"policy"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="TLSEdgeList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.TLSEdgeList">[docs]</a><span class="k">class</span> <span class="nc">TLSEdgeList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
@@ -3472,6 +3871,11 @@
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"tls_termination"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"policy"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="n">EndpointPolicy</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">"policy"</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"policy"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
@@ -3491,6 +3895,7 @@
|
||||
<span class="n">ip_restriction</span><span class="p">:</span> <span class="n">EndpointIPPolicyMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">mutual_tls</span><span class="p">:</span> <span class="n">EndpointMutualTLSMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">tls_termination</span><span class="p">:</span> <span class="n">EndpointTLSTermination</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">edges</span><span class="o">.</span><span class="n">tls</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
@@ -3501,6 +3906,7 @@
|
||||
<span class="n">ip_restriction</span><span class="o">=</span><span class="n">ip_restriction</span><span class="p">,</span>
|
||||
<span class="n">mutual_tls</span><span class="o">=</span><span class="n">mutual_tls</span><span class="p">,</span>
|
||||
<span class="n">tls_termination</span><span class="o">=</span><span class="n">tls_termination</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="o">=</span><span class="n">policy</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TLSEdge.delete"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.TLSEdge.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
@@ -3555,7 +3961,12 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">tls_termination</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointTLSTermination</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"tls_termination"</span><span class="p">]</span></div>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"tls_termination"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">policy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointPolicy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""the traffic policy associated with this edge or null"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"policy"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Endpoint"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.Endpoint">[docs]</a><span class="k">class</span> <span class="nc">Endpoint</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
@@ -4706,12 +5117,12 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">region</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)"""</span>
|
||||
<span class="w"> </span><span class="sd">"""deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"region"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">cname_target</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io"""</span>
|
||||
<span class="w"> </span><span class="sd">"""DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of an ngrok owned domain (e.g. *.ngrok.app)"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"cname_target"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
|
||||
@@ -169,8 +169,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_sessions.html">Tunnel Sessions</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="../../static_backends.html">Static 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="../../bot_users.html">Bot Users</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="../../edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -188,14 +190,18 @@
|
||||
<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="../../edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_policy_module.html">HTTPS Edge Route Policies 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="../../tcp_edge_policy_module.html">TCP Edge Policy 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="../../tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
|
||||
@@ -169,8 +169,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_sessions.html">Tunnel Sessions</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="../../static_backends.html">Static 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="../../bot_users.html">Bot Users</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="../../edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -188,14 +190,18 @@
|
||||
<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="../../edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../edge_route_policy_module.html">HTTPS Edge Route Policies 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="../../tcp_edge_policy_module.html">TCP Edge Policy 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="../../tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -989,6 +995,126 @@
|
||||
<span class="k">return</span> <span class="n">HTTPResponseBackend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="StaticBackendsClient"><a class="viewcode-back" href="../../static_backends.html#ngrok.services.StaticBackendsClient">[docs]</a><span class="k">class</span> <span class="nc">StaticBackendsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""A static backend sends traffic to a TCP address (hostname and port) that</span>
|
||||
<span class="sd"> is reachable on the public internet."""</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
|
||||
<div class="viewcode-block" id="StaticBackendsClient.create"><a class="viewcode-back" href="../../static_backends.html#ngrok.services.StaticBackendsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">address</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">tls</span><span class="p">:</span> <span class="n">StaticBackendTLS</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">StaticBackend</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create a new static backend</span>
|
||||
|
||||
<span class="sd"> :param description: human-readable description of this backend. Optional</span>
|
||||
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this backend. Optional</span>
|
||||
<span class="sd"> :param address: the address to forward to</span>
|
||||
<span class="sd"> :param tls: tls configuration to use</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-static-backends-create</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/backends/static"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
||||
<span class="n">address</span><span class="o">=</span><span class="n">address</span><span class="p">,</span>
|
||||
<span class="n">tls</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">tls</span><span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">StaticBackend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StaticBackendsClient.delete"><a class="viewcode-back" href="../../static_backends.html#ngrok.services.StaticBackendsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Delete a static backend by ID.</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-static-backends-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/backends/static/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StaticBackendsClient.get"><a class="viewcode-back" href="../../static_backends.html#ngrok.services.StaticBackendsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">StaticBackend</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get detailed information about a static backend by ID</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-static-backends-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/backends/static/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">StaticBackend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StaticBackendsClient.list"><a class="viewcode-back" href="../../static_backends.html#ngrok.services.StaticBackendsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">StaticBackendList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all static backends on this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-static-backends-list</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/backends/static"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">StaticBackendList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StaticBackendsClient.update"><a class="viewcode-back" href="../../static_backends.html#ngrok.services.StaticBackendsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">address</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">tls</span><span class="p">:</span> <span class="n">StaticBackendTLS</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">StaticBackend</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Update static backend by ID</span>
|
||||
|
||||
<span class="sd"> :param id:</span>
|
||||
<span class="sd"> :param description: human-readable description of this backend. Optional</span>
|
||||
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this backend. Optional</span>
|
||||
<span class="sd"> :param address: the address to forward to</span>
|
||||
<span class="sd"> :param tls: tls configuration to use</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-static-backends-update</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/backends/static/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
||||
<span class="n">address</span><span class="o">=</span><span class="n">address</span><span class="p">,</span>
|
||||
<span class="n">tls</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">tls</span><span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">StaticBackend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="TunnelGroupBackendsClient"><a class="viewcode-back" href="../../tunnel_group_backends.html#ngrok.services.TunnelGroupBackendsClient">[docs]</a><span class="k">class</span> <span class="nc">TunnelGroupBackendsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""A Tunnel Group Backend balances traffic among all online tunnels that match</span>
|
||||
<span class="sd"> a label selector."""</span>
|
||||
@@ -1219,6 +1345,111 @@
|
||||
<span class="k">return</span> <span class="n">WeightedBackend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="BotUsersClient"><a class="viewcode-back" href="../../bot_users.html#ngrok.services.BotUsersClient">[docs]</a><span class="k">class</span> <span class="nc">BotUsersClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
|
||||
<div class="viewcode-block" id="BotUsersClient.create"><a class="viewcode-back" href="../../bot_users.html#ngrok.services.BotUsersClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">BotUser</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create a new bot user</span>
|
||||
|
||||
<span class="sd"> :param name: human-readable name used to identify the bot</span>
|
||||
<span class="sd"> :param active: whether or not the bot is active</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-bot-users-create</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/bot_users"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="o">=</span><span class="n">active</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">BotUser</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="BotUsersClient.delete"><a class="viewcode-back" href="../../bot_users.html#ngrok.services.BotUsersClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Delete a bot user by ID</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-bot-users-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/bot_users/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="BotUsersClient.get"><a class="viewcode-back" href="../../bot_users.html#ngrok.services.BotUsersClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">BotUser</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get the details of a Bot User by ID.</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-bot-users-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/bot_users/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">BotUser</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="BotUsersClient.list"><a class="viewcode-back" href="../../bot_users.html#ngrok.services.BotUsersClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">BotUserList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all bot users in this account.</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-bot-users-list</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/bot_users"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">BotUserList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="BotUsersClient.update"><a class="viewcode-back" href="../../bot_users.html#ngrok.services.BotUsersClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">BotUser</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Update attributes of a bot user by ID.</span>
|
||||
|
||||
<span class="sd"> :param id:</span>
|
||||
<span class="sd"> :param name: human-readable name used to identify the bot</span>
|
||||
<span class="sd"> :param active: whether or not the bot is active</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-bot-users-update</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/bot_users/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="o">=</span><span class="n">active</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">BotUser</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="CertificateAuthoritiesClient"><a class="viewcode-back" href="../../certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient">[docs]</a><span class="k">class</span> <span class="nc">CertificateAuthoritiesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Certificate Authorities are x509 certificates that are used to sign other</span>
|
||||
<span class="sd"> x509 certificates. Attach a Certificate Authority to the Mutual TLS module</span>
|
||||
@@ -1474,6 +1705,8 @@
|
||||
<span class="n">saml</span><span class="p">:</span> <span class="n">EndpointSAMLMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">oidc</span><span class="p">:</span> <span class="n">EndpointOIDC</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">websocket_tcp_converter</span><span class="p">:</span> <span class="n">EndpointWebsocketTCPConverter</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">user_agent_filter</span><span class="p">:</span> <span class="n">EndpointUserAgentFilter</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">HTTPSEdgeRoute</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create an HTTPS Edge Route</span>
|
||||
|
||||
@@ -1493,6 +1726,8 @@
|
||||
<span class="sd"> :param saml: saml module configuration or ``null``</span>
|
||||
<span class="sd"> :param oidc: oidc module configuration or ``null``</span>
|
||||
<span class="sd"> :param websocket_tcp_converter: websocket to tcp adapter configuration or ``null``</span>
|
||||
<span class="sd"> :param user_agent_filter:</span>
|
||||
<span class="sd"> :param policy: the traffic policy associated with this edge or null</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edges-https-routes-create</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -1516,6 +1751,8 @@
|
||||
<span class="n">saml</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">saml</span><span class="p">),</span>
|
||||
<span class="n">oidc</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">oidc</span><span class="p">),</span>
|
||||
<span class="n">websocket_tcp_converter</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">websocket_tcp_converter</span><span class="p">),</span>
|
||||
<span class="n">user_agent_filter</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">user_agent_filter</span><span class="p">),</span>
|
||||
<span class="n">policy</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">policy</span><span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">HTTPSEdgeRoute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
@@ -1560,6 +1797,8 @@
|
||||
<span class="n">saml</span><span class="p">:</span> <span class="n">EndpointSAMLMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">oidc</span><span class="p">:</span> <span class="n">EndpointOIDC</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">websocket_tcp_converter</span><span class="p">:</span> <span class="n">EndpointWebsocketTCPConverter</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">user_agent_filter</span><span class="p">:</span> <span class="n">EndpointUserAgentFilter</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">HTTPSEdgeRoute</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</span>
|
||||
|
||||
@@ -1580,6 +1819,8 @@
|
||||
<span class="sd"> :param saml: saml module configuration or ``null``</span>
|
||||
<span class="sd"> :param oidc: oidc module configuration or ``null``</span>
|
||||
<span class="sd"> :param websocket_tcp_converter: websocket to tcp adapter configuration or ``null``</span>
|
||||
<span class="sd"> :param user_agent_filter:</span>
|
||||
<span class="sd"> :param policy: the traffic policy associated with this edge or null</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edges-https-routes-update</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -1604,6 +1845,8 @@
|
||||
<span class="n">saml</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">saml</span><span class="p">),</span>
|
||||
<span class="n">oidc</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">oidc</span><span class="p">),</span>
|
||||
<span class="n">websocket_tcp_converter</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">websocket_tcp_converter</span><span class="p">),</span>
|
||||
<span class="n">user_agent_filter</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">user_agent_filter</span><span class="p">),</span>
|
||||
<span class="n">policy</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">policy</span><span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">HTTPSEdgeRoute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
@@ -2631,6 +2874,144 @@
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EdgeRouteUserAgentFilterModuleClient"><a class="viewcode-back" href="../../edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EdgeRouteUserAgentFilterModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
|
||||
<div class="viewcode-block" id="EdgeRouteUserAgentFilterModuleClient.replace"><a class="viewcode-back" href="../../edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">module</span><span class="p">:</span> <span class="n">EndpointUserAgentFilter</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointUserAgentFilter</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param edge_id:</span>
|
||||
<span class="sd"> :param id:</span>
|
||||
<span class="sd"> :param module:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-replace</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/https/</span><span class="si">{edge_id}</span><span class="s2">/routes/</span><span class="si">{id}</span><span class="s2">/user_agent_filter"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">edge_id</span><span class="o">=</span><span class="n">edge_id</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="n">extract_props</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointUserAgentFilter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="EdgeRouteUserAgentFilterModuleClient.get"><a class="viewcode-back" href="../../edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointUserAgentFilter</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param edge_id: unique identifier of this edge</span>
|
||||
<span class="sd"> :param id: unique identifier of this edge route</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/https/</span><span class="si">{edge_id}</span><span class="s2">/routes/</span><span class="si">{id}</span><span class="s2">/user_agent_filter"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">edge_id</span><span class="o">=</span><span class="n">edge_id</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointUserAgentFilter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="EdgeRouteUserAgentFilterModuleClient.delete"><a class="viewcode-back" href="../../edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param edge_id: unique identifier of this edge</span>
|
||||
<span class="sd"> :param id: unique identifier of this edge route</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/https/</span><span class="si">{edge_id}</span><span class="s2">/routes/</span><span class="si">{id}</span><span class="s2">/user_agent_filter"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">edge_id</span><span class="o">=</span><span class="n">edge_id</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EdgeRoutePolicyModuleClient"><a class="viewcode-back" href="../../edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EdgeRoutePolicyModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
|
||||
<div class="viewcode-block" id="EdgeRoutePolicyModuleClient.replace"><a class="viewcode-back" href="../../edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">module</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointPolicy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param edge_id:</span>
|
||||
<span class="sd"> :param id:</span>
|
||||
<span class="sd"> :param module:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edge-route-policy-module-replace</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/https/</span><span class="si">{edge_id}</span><span class="s2">/routes/</span><span class="si">{id}</span><span class="s2">/policy"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">edge_id</span><span class="o">=</span><span class="n">edge_id</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="n">extract_props</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointPolicy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="EdgeRoutePolicyModuleClient.get"><a class="viewcode-back" href="../../edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointPolicy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param edge_id: unique identifier of this edge</span>
|
||||
<span class="sd"> :param id: unique identifier of this edge route</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edge-route-policy-module-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/https/</span><span class="si">{edge_id}</span><span class="s2">/routes/</span><span class="si">{id}</span><span class="s2">/policy"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">edge_id</span><span class="o">=</span><span class="n">edge_id</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointPolicy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="EdgeRoutePolicyModuleClient.delete"><a class="viewcode-back" href="../../edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param edge_id: unique identifier of this edge</span>
|
||||
<span class="sd"> :param id: unique identifier of this edge route</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edge-route-policy-module-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/https/</span><span class="si">{edge_id}</span><span class="s2">/routes/</span><span class="si">{id}</span><span class="s2">/policy"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">edge_id</span><span class="o">=</span><span class="n">edge_id</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EdgesTCPClient"><a class="viewcode-back" href="../../edges_tcp.html#ngrok.services.EdgesTCPClient">[docs]</a><span class="k">class</span> <span class="nc">EdgesTCPClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
@@ -2642,6 +3023,7 @@
|
||||
<span class="n">hostports</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">backend</span><span class="p">:</span> <span class="n">EndpointBackendMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">ip_restriction</span><span class="p">:</span> <span class="n">EndpointIPPolicyMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">TCPEdge</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create a TCP Edge</span>
|
||||
|
||||
@@ -2650,6 +3032,7 @@
|
||||
<span class="sd"> :param hostports: hostports served by this edge</span>
|
||||
<span class="sd"> :param backend: edge modules</span>
|
||||
<span class="sd"> :param ip_restriction:</span>
|
||||
<span class="sd"> :param policy: the traffic policy associated with this edge or null</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edges-tcp-create</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -2660,6 +3043,7 @@
|
||||
<span class="n">hostports</span><span class="o">=</span><span class="n">hostports</span><span class="p">,</span>
|
||||
<span class="n">backend</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">backend</span><span class="p">),</span>
|
||||
<span class="n">ip_restriction</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">ip_restriction</span><span class="p">),</span>
|
||||
<span class="n">policy</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">policy</span><span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">TCPEdge</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
@@ -2710,6 +3094,7 @@
|
||||
<span class="n">hostports</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">backend</span><span class="p">:</span> <span class="n">EndpointBackendMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">ip_restriction</span><span class="p">:</span> <span class="n">EndpointIPPolicyMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">TCPEdge</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</span>
|
||||
|
||||
@@ -2719,6 +3104,7 @@
|
||||
<span class="sd"> :param hostports: hostports served by this edge</span>
|
||||
<span class="sd"> :param backend: edge modules</span>
|
||||
<span class="sd"> :param ip_restriction:</span>
|
||||
<span class="sd"> :param policy: the traffic policy associated with this edge or null</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edges-tcp-update</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -2732,6 +3118,7 @@
|
||||
<span class="n">hostports</span><span class="o">=</span><span class="n">hostports</span><span class="p">,</span>
|
||||
<span class="n">backend</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">backend</span><span class="p">),</span>
|
||||
<span class="n">ip_restriction</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">ip_restriction</span><span class="p">),</span>
|
||||
<span class="n">policy</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">policy</span><span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">TCPEdge</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
@@ -2874,6 +3261,66 @@
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="TCPEdgePolicyModuleClient"><a class="viewcode-back" href="../../tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient">[docs]</a><span class="k">class</span> <span class="nc">TCPEdgePolicyModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
|
||||
<div class="viewcode-block" id="TCPEdgePolicyModuleClient.replace"><a class="viewcode-back" href="../../tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">module</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointPolicy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param id:</span>
|
||||
<span class="sd"> :param module:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-tcp-edge-policy-module-replace</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/tcp/</span><span class="si">{id}</span><span class="s2">/policy"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="n">extract_props</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointPolicy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TCPEdgePolicyModuleClient.get"><a class="viewcode-back" href="../../tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointPolicy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-tcp-edge-policy-module-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/tcp/</span><span class="si">{id}</span><span class="s2">/policy"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointPolicy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TCPEdgePolicyModuleClient.delete"><a class="viewcode-back" href="../../tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-tcp-edge-policy-module-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/tcp/</span><span class="si">{id}</span><span class="s2">/policy"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EdgesTLSClient"><a class="viewcode-back" href="../../edges_tls.html#ngrok.services.EdgesTLSClient">[docs]</a><span class="k">class</span> <span class="nc">EdgesTLSClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
@@ -2887,6 +3334,7 @@
|
||||
<span class="n">ip_restriction</span><span class="p">:</span> <span class="n">EndpointIPPolicyMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">mutual_tls</span><span class="p">:</span> <span class="n">EndpointMutualTLSMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">tls_termination</span><span class="p">:</span> <span class="n">EndpointTLSTermination</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">TLSEdge</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create a TLS Edge</span>
|
||||
|
||||
@@ -2897,6 +3345,7 @@
|
||||
<span class="sd"> :param ip_restriction:</span>
|
||||
<span class="sd"> :param mutual_tls:</span>
|
||||
<span class="sd"> :param tls_termination:</span>
|
||||
<span class="sd"> :param policy: the traffic policy associated with this edge or null</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edges-tls-create</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -2909,6 +3358,7 @@
|
||||
<span class="n">ip_restriction</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">ip_restriction</span><span class="p">),</span>
|
||||
<span class="n">mutual_tls</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">mutual_tls</span><span class="p">),</span>
|
||||
<span class="n">tls_termination</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">tls_termination</span><span class="p">),</span>
|
||||
<span class="n">policy</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">policy</span><span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">TLSEdge</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
@@ -2961,6 +3411,7 @@
|
||||
<span class="n">ip_restriction</span><span class="p">:</span> <span class="n">EndpointIPPolicyMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">mutual_tls</span><span class="p">:</span> <span class="n">EndpointMutualTLSMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">tls_termination</span><span class="p">:</span> <span class="n">EndpointTLSTermination</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">policy</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">TLSEdge</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</span>
|
||||
|
||||
@@ -2972,6 +3423,7 @@
|
||||
<span class="sd"> :param ip_restriction:</span>
|
||||
<span class="sd"> :param mutual_tls:</span>
|
||||
<span class="sd"> :param tls_termination:</span>
|
||||
<span class="sd"> :param policy: the traffic policy associated with this edge or null</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-edges-tls-update</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -2987,6 +3439,7 @@
|
||||
<span class="n">ip_restriction</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">ip_restriction</span><span class="p">),</span>
|
||||
<span class="n">mutual_tls</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">mutual_tls</span><span class="p">),</span>
|
||||
<span class="n">tls_termination</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">tls_termination</span><span class="p">),</span>
|
||||
<span class="n">policy</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">policy</span><span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">TLSEdge</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
@@ -3249,6 +3702,66 @@
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="TLSEdgePolicyModuleClient"><a class="viewcode-back" href="../../tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient">[docs]</a><span class="k">class</span> <span class="nc">TLSEdgePolicyModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
|
||||
<div class="viewcode-block" id="TLSEdgePolicyModuleClient.replace"><a class="viewcode-back" href="../../tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">module</span><span class="p">:</span> <span class="n">EndpointPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointPolicy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param id:</span>
|
||||
<span class="sd"> :param module:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-tls-edge-policy-module-replace</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/tls/</span><span class="si">{id}</span><span class="s2">/policy"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="n">extract_props</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointPolicy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TLSEdgePolicyModuleClient.get"><a class="viewcode-back" href="../../tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointPolicy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-tls-edge-policy-module-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/tls/</span><span class="si">{id}</span><span class="s2">/policy"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointPolicy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TLSEdgePolicyModuleClient.delete"><a class="viewcode-back" href="../../tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-tls-edge-policy-module-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/edges/tls/</span><span class="si">{id}</span><span class="s2">/policy"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EndpointsClient"><a class="viewcode-back" href="../../endpoints.html#ngrok.services.EndpointsClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="w"> </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>
|
||||
@@ -4127,7 +4640,7 @@
|
||||
<span class="w"> </span><span class="sd">"""Create a new reserved domain.</span>
|
||||
|
||||
<span class="sd"> :param domain: hostname of the reserved domain</span>
|
||||
<span class="sd"> :param region: reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</span>
|
||||
<span class="sd"> :param region: deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)</span>
|
||||
<span class="sd"> :param description: human-readable description of what this reserved domain will be used for</span>
|
||||
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</span>
|
||||
<span class="sd"> :param certificate_id: ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.</span>
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Bot Users
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.bot_users` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: BotUsersClient
|
||||
:undoc-members: BotUsersClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
HTTPS Edge Route Policies Module
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.edge_route_policy_module` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: EdgeRoutePolicyModuleClient
|
||||
:undoc-members: EdgeRoutePolicyModuleClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
HTTPS Edge Route User Agent Filter Module
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.edge_route_user_agent_filter_module` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: EdgeRouteUserAgentFilterModuleClient
|
||||
:undoc-members: EdgeRouteUserAgentFilterModuleClient
|
||||
@@ -131,8 +131,10 @@ API Reference
|
||||
tunnel_sessions
|
||||
failover_backends
|
||||
http_response_backends
|
||||
static_backends
|
||||
tunnel_group_backends
|
||||
weighted_backends
|
||||
bot_users
|
||||
certificate_authorities
|
||||
credentials
|
||||
edges_https_routes
|
||||
@@ -150,14 +152,18 @@ API Reference
|
||||
edge_route_saml_module
|
||||
edge_route_oidc_module
|
||||
edge_route_websocket_tcp_converter_module
|
||||
edge_route_user_agent_filter_module
|
||||
edge_route_policy_module
|
||||
edges_tcp
|
||||
tcp_edge_backend_module
|
||||
tcp_edge_ip_restriction_module
|
||||
tcp_edge_policy_module
|
||||
edges_tls
|
||||
tls_edge_backend_module
|
||||
tls_edge_ip_restriction_module
|
||||
tls_edge_mutual_tls_module
|
||||
tls_edge_tls_termination_module
|
||||
tls_edge_policy_module
|
||||
endpoints
|
||||
event_destinations
|
||||
event_subscriptions
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Static Backends
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.static_backends` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: StaticBackendsClient
|
||||
:undoc-members: StaticBackendsClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
TCP Edge Policy Module
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.tcp_edge_policy_module` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: TCPEdgePolicyModuleClient
|
||||
:undoc-members: TCPEdgePolicyModuleClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
TLS Edge Policy Module
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.tls_edge_policy_module` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: TLSEdgePolicyModuleClient
|
||||
:undoc-members: TLSEdgePolicyModuleClient
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -263,7 +269,7 @@
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p></li>
|
||||
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the domain that you own to be used as the base domain name to generate regional agent ingress domains.</p></li>
|
||||
<li><p><strong>certificate_management_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.AgentIngressCertPolicy" title="ngrok.datatypes.AgentIngressCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">AgentIngressCertPolicy</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p></li>
|
||||
<li><p><strong>certificate_management_policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.AgentIngressCertPolicy" title="ngrok.datatypes.AgentIngressCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">AgentIngressCertPolicy</span></code></a>) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -311,8 +317,8 @@
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -332,9 +338,9 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p></li>
|
||||
<li><p><strong>certificate_management_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.AgentIngressCertPolicy" title="ngrok.datatypes.AgentIngressCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">AgentIngressCertPolicy</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p></li>
|
||||
<li><p><strong>certificate_management_policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.AgentIngressCertPolicy" title="ngrok.datatypes.AgentIngressCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">AgentIngressCertPolicy</span></code></a>) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+11
-5
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -267,7 +273,7 @@ ngrok.com dashboard.</p>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined data of this API key. optional, max 4096 bytes</p></li>
|
||||
<li><p><strong>owner_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
|
||||
<li><p><strong>owner_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -315,8 +321,8 @@ ngrok.com dashboard.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -336,8 +342,8 @@ ngrok.com dashboard.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined data of this API key. optional, max 4096 bytes</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined data of this API key. optional, max 4096 bytes</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -289,8 +295,8 @@
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -289,8 +295,8 @@
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -0,0 +1,436 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<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="Weighted Backends" href="weighted_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Bot Users - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<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="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="#">Bot Users</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="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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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="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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="bot-users">
|
||||
<h1>Bot Users<a class="headerlink" href="#bot-users" title="Permalink to this heading">#</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<a class="reference internal" href="client.html#ngrok.Client.bot_users" title="ngrok.Client.bot_users"><code class="xref py py-attr docutils literal notranslate"><span class="pre">bot_users</span></code></a> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.services.BotUsersClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">BotUsersClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#BotUsersClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.BotUsersClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.BotUsersClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#BotUsersClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.BotUsersClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create a new bot user</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable name used to identify the bot</p></li>
|
||||
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – whether or not the bot is active</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-bot-users-create">https://ngrok.com/docs/api#api-bot-users-create</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser" title="ngrok.datatypes.BotUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">BotUser</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.BotUsersClient.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#BotUsersClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.BotUsersClient.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Delete a bot user by ID</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-bot-users-delete">https://ngrok.com/docs/api#api-bot-users-delete</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.BotUsersClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#BotUsersClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.BotUsersClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Get the details of a Bot User by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-bot-users-get">https://ngrok.com/docs/api#api-bot-users-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser" title="ngrok.datatypes.BotUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">BotUser</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.BotUsersClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#BotUsersClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.BotUsersClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all bot users in this account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-bot-users-list">https://ngrok.com/docs/api#api-bot-users-list</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUserList" title="ngrok.datatypes.BotUserList"><code class="xref py py-class docutils literal notranslate"><span class="pre">BotUserList</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.BotUsersClient.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#BotUsersClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.BotUsersClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Update attributes of a bot user by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable name used to identify the bot</p></li>
|
||||
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – whether or not the bot is active</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-bot-users-update">https://ngrok.com/docs/api#api-bot-users-update</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser" title="ngrok.datatypes.BotUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">BotUser</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="certificate_authorities.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Certificate Authorities</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="weighted_backends.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Weighted Backends</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Bot Users</a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.BotUsersClient"><code class="docutils literal notranslate"><span class="pre">BotUsersClient</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.BotUsersClient.create"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.create()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.BotUsersClient.delete"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.BotUsersClient.get"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.BotUsersClient.list"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.list()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.BotUsersClient.update"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/scripts/furo.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<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" />
|
||||
<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="Bot Users" href="bot_users.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Certificate Authorities - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -315,8 +321,8 @@ thus a private key is not included in the resource.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -336,8 +342,8 @@ thus a private key is not included in the resource.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this Certificate Authority. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this Certificate Authority. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -367,14 +373,14 @@ thus a private key is not included in the resource.</p>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="weighted_backends.html">
|
||||
<a class="prev-page" href="bot_users.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Weighted Backends</div>
|
||||
<div class="title">Bot Users</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -330,6 +336,16 @@ ngrok.com dashboard.</p>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">backends</span></span><a class="headerlink" href="#ngrok.Client.backends" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.Client.bot_users">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bot_users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient" title="ngrok.services.BotUsersClient"><span class="pre">BotUsersClient</span></a></em><a class="headerlink" href="#ngrok.Client.bot_users" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient" title="ngrok.services.BotUsersClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">BotUsersClient</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.Client.certificate_authorities">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">certificate_authorities</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient" title="ngrok.services.CertificateAuthoritiesClient"><span class="pre">CertificateAuthoritiesClient</span></a></em><a class="headerlink" href="#ngrok.Client.certificate_authorities" title="Permalink to this definition">#</a></dt>
|
||||
@@ -638,6 +654,7 @@ agent tunnel session or an SSH reverse tunnel session.</p>
|
||||
<li><a class="reference internal" href="#ngrok.Client.application_sessions"><code class="docutils literal notranslate"><span class="pre">Client.application_sessions</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.application_users"><code class="docutils literal notranslate"><span class="pre">Client.application_users</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.backends"><code class="docutils literal notranslate"><span class="pre">Client.backends</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.bot_users"><code class="docutils literal notranslate"><span class="pre">Client.bot_users</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.certificate_authorities"><code class="docutils literal notranslate"><span class="pre">Client.certificate_authorities</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.credentials"><code class="docutils literal notranslate"><span class="pre">Client.credentials</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.edge_modules"><code class="docutils literal notranslate"><span class="pre">Client.edge_modules</span></code></a></li>
|
||||
|
||||
+12
-6
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -267,7 +273,7 @@ configuration file with the <code class="docutils literal notranslate"><span cla
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>owner_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
|
||||
<li><p><strong>owner_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -315,8 +321,8 @@ configuration file with the <code class="docutils literal notranslate"><span cla
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -336,9 +342,9 @@ configuration file with the <code class="docutils literal notranslate"><span cla
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+512
-6
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -1151,6 +1157,114 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUser">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">BotUser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#BotUser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.BotUser" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUser.active">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">active</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#ngrok.datatypes.BotUser.active" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>whether or not the bot is active</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUser.created_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#ngrok.datatypes.BotUser.created_at" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>timestamp when the api key was created, RFC 3339 format</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUser.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#BotUser.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.BotUser.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUser.id">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.BotUser.id" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>unique API key resource identifier</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUser.name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.BotUser.name" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>human-readable name used to identify the bot</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUser.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#BotUser.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.BotUser.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUser.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.BotUser.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI to the API resource of this bot user</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUserList">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">BotUserList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#BotUserList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.BotUserList" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUserList.bot_users">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bot_users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ngrok.datatypes.BotUser" title="ngrok.datatypes.BotUser"><span class="pre">BotUser</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.BotUserList.bot_users" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the list of all bot users on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.BotUser" title="ngrok.datatypes.BotUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">BotUser</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUserList.next_page_uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">next_page_uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.BotUserList.next_page_uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BotUserList.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.BotUserList.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the bot users list API resource</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.BrowserSession">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">BrowserSession</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#BrowserSession"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.BrowserSession" title="Permalink to this definition">#</a></dt>
|
||||
@@ -1652,6 +1766,33 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointAction">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">EndpointAction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointAction"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointAction" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointAction.config">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">object</span></em><a class="headerlink" href="#ngrok.datatypes.EndpointAction.config" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the configuration for the action on the policy rule.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointAction.type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.EndpointAction.type" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the type of action on the policy rule.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointBackend">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">EndpointBackend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointBackend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointBackend" title="Permalink to this definition">#</a></dt>
|
||||
@@ -2700,6 +2841,44 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointPolicy">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">EndpointPolicy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointPolicy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointPolicy" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointPolicy.enabled">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#ngrok.datatypes.EndpointPolicy.enabled" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointPolicy.inbound">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inbound</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ngrok.datatypes.EndpointRule" title="ngrok.datatypes.EndpointRule"><span class="pre">EndpointRule</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.EndpointPolicy.inbound" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the inbound rules of the traffic policy.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.EndpointRule" title="ngrok.datatypes.EndpointRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRule</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointPolicy.outbound">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outbound</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ngrok.datatypes.EndpointRule" title="ngrok.datatypes.EndpointRule"><span class="pre">EndpointRule</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.EndpointPolicy.outbound" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the outbound rules on the traffic policy.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.EndpointRule" title="ngrok.datatypes.EndpointRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRule</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointRequestHeaders">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">EndpointRequestHeaders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointRequestHeaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointRequestHeaders" title="Permalink to this definition">#</a></dt>
|
||||
@@ -2776,6 +2955,44 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointRule">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">EndpointRule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointRule"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointRule" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointRule.actions">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ngrok.datatypes.EndpointAction" title="ngrok.datatypes.EndpointAction"><span class="pre">EndpointAction</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.EndpointRule.actions" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the set of actions on a policy rule.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.EndpointAction" title="ngrok.datatypes.EndpointAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointAction</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointRule.expressions">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">expressions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.EndpointRule.expressions" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>cel expressions that filter traffic the policy rule applies to.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointRule.name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.EndpointRule.name" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the name of the rule that is part of the traffic policy.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointSAML">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">EndpointSAML</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointSAML"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointSAML" title="Permalink to this definition">#</a></dt>
|
||||
@@ -3126,6 +3343,41 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointUserAgentFilter">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">EndpointUserAgentFilter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointUserAgentFilter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointUserAgentFilter" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointUserAgentFilter.allow">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">allow</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.EndpointUserAgentFilter.allow" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointUserAgentFilter.deny">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deny</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.EndpointUserAgentFilter.deny" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointUserAgentFilter.enabled">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#ngrok.datatypes.EndpointUserAgentFilter.enabled" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointWebhookValidation">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">EndpointWebhookValidation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointWebhookValidation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointWebhookValidation" title="Permalink to this definition">#</a></dt>
|
||||
@@ -3143,7 +3395,7 @@
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.EndpointWebhookValidation.provider">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">provider</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.EndpointWebhookValidation.provider" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at <a class="reference external" href="https://ngrok.com/docs/cloud-edge/modules/webhook">https://ngrok.com/docs/cloud-edge/modules/webhook</a></p>
|
||||
<dd><p>a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at <a class="reference external" href="https://ngrok.com/docs/cloud-edge/modules/webhook-verification">https://ngrok.com/docs/cloud-edge/modules/webhook-verification</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
@@ -4236,6 +4488,17 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.HTTPSEdgeRoute.policy">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">policy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><span class="pre">EndpointPolicy</span></a></em><a class="headerlink" href="#ngrok.datatypes.HTTPSEdgeRoute.policy" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the traffic policy associated with this edge or null</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.HTTPSEdgeRoute.request_headers">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request_headers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><span class="pre">EndpointRequestHeaders</span></a></em><a class="headerlink" href="#ngrok.datatypes.HTTPSEdgeRoute.request_headers" title="Permalink to this definition">#</a></dt>
|
||||
@@ -4271,7 +4534,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.HTTPSEdgeRoute.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">match_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">circuit_breaker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">webhook_verification</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">saml</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_tcp_converter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#HTTPSEdgeRoute.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.HTTPSEdgeRoute.update" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">match_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">circuit_breaker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">webhook_verification</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">saml</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_tcp_converter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_agent_filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#HTTPSEdgeRoute.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.HTTPSEdgeRoute.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
@@ -4285,6 +4548,16 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.HTTPSEdgeRoute.user_agent_filter">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user_agent_filter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.EndpointUserAgentFilter" title="ngrok.datatypes.EndpointUserAgentFilter"><span class="pre">EndpointUserAgentFilter</span></a></em><a class="headerlink" href="#ngrok.datatypes.HTTPSEdgeRoute.user_agent_filter" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointUserAgentFilter" title="ngrok.datatypes.EndpointUserAgentFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointUserAgentFilter</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.HTTPSEdgeRoute.webhook_verification">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">webhook_verification</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><span class="pre">EndpointWebhookValidation</span></a></em><a class="headerlink" href="#ngrok.datatypes.HTTPSEdgeRoute.webhook_verification" title="Permalink to this definition">#</a></dt>
|
||||
@@ -4972,7 +5245,7 @@
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ReservedDomain.cname_target">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cname_target</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.cname_target" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of <a href="#id1"><span class="problematic" id="id2">*</span></a>.ngrok.io</p>
|
||||
<dd><p>DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of an ngrok owned domain (e.g. <a href="#id1"><span class="problematic" id="id2">*</span></a>.ngrok.app)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
@@ -5043,7 +5316,7 @@
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ReservedDomain.region">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">region</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.region" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p>
|
||||
<dd><p>deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
@@ -5868,6 +6141,152 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">StaticBackend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#StaticBackend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.StaticBackend" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend.address">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">address</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackend.address" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the address to forward to</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend.created_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackend.created_at" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>timestamp when the backend was created, RFC 3339 format</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#StaticBackend.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.StaticBackend.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend.description">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackend.description" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>human-readable description of this backend. Optional</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend.id">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackend.id" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>unique identifier for this static backend</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend.metadata">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackend.metadata" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>arbitrary user-defined machine-readable data of this backend. Optional</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend.tls">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tls</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.StaticBackendTLS" title="ngrok.datatypes.StaticBackendTLS"><span class="pre">StaticBackendTLS</span></a></em><a class="headerlink" href="#ngrok.datatypes.StaticBackend.tls" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>tls configuration to use</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.StaticBackendTLS" title="ngrok.datatypes.StaticBackendTLS"><code class="xref py py-class docutils literal notranslate"><span class="pre">StaticBackendTLS</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#StaticBackend.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.StaticBackend.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackend.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the StaticBackend API resource</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackendList">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">StaticBackendList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#StaticBackendList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.StaticBackendList" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackendList.backends">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">backends</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ngrok.datatypes.StaticBackend" title="ngrok.datatypes.StaticBackend"><span class="pre">StaticBackend</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackendList.backends" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the list of all static backends on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.StaticBackend" title="ngrok.datatypes.StaticBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">StaticBackend</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackendList.next_page_uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">next_page_uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackendList.next_page_uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackendList.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackendList.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the static backends list API resource</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackendTLS">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">StaticBackendTLS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#StaticBackendTLS"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.StaticBackendTLS" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackendTLS.enabled">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#ngrok.datatypes.StaticBackendTLS.enabled" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>if TLS is checked</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.TCPEdge">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">TCPEdge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TCPEdge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TCPEdge" title="Permalink to this definition">#</a></dt>
|
||||
@@ -5952,9 +6371,20 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.TCPEdge.policy">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">policy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><span class="pre">EndpointPolicy</span></a></em><a class="headerlink" href="#ngrok.datatypes.TCPEdge.policy" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the traffic policy associated with this edge or null</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.TCPEdge.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TCPEdge.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TCPEdge.update" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TCPEdge.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TCPEdge.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
@@ -6413,6 +6843,17 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.TLSEdge.policy">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">policy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><span class="pre">EndpointPolicy</span></a></em><a class="headerlink" href="#ngrok.datatypes.TLSEdge.policy" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the traffic policy associated with this edge or null</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.TLSEdge.tls_termination">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tls_termination</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><span class="pre">EndpointTLSTermination</span></a></em><a class="headerlink" href="#ngrok.datatypes.TLSEdge.tls_termination" title="Permalink to this definition">#</a></dt>
|
||||
@@ -6425,7 +6866,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.TLSEdge.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mutual_tls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_termination</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TLSEdge.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TLSEdge.update" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mutual_tls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_termination</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TLSEdge.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TLSEdge.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
@@ -7300,6 +7741,22 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ApplicationUserList.uri"><code class="docutils literal notranslate"><span class="pre">ApplicationUserList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUser"><code class="docutils literal notranslate"><span class="pre">BotUser</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUser.active"><code class="docutils literal notranslate"><span class="pre">BotUser.active</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUser.created_at"><code class="docutils literal notranslate"><span class="pre">BotUser.created_at</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUser.delete"><code class="docutils literal notranslate"><span class="pre">BotUser.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUser.id"><code class="docutils literal notranslate"><span class="pre">BotUser.id</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUser.name"><code class="docutils literal notranslate"><span class="pre">BotUser.name</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUser.update"><code class="docutils literal notranslate"><span class="pre">BotUser.update()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUser.uri"><code class="docutils literal notranslate"><span class="pre">BotUser.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUserList"><code class="docutils literal notranslate"><span class="pre">BotUserList</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUserList.bot_users"><code class="docutils literal notranslate"><span class="pre">BotUserList.bot_users</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUserList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">BotUserList.next_page_uri</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BotUserList.uri"><code class="docutils literal notranslate"><span class="pre">BotUserList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BrowserSession"><code class="docutils literal notranslate"><span class="pre">BrowserSession</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BrowserSession.ip_address"><code class="docutils literal notranslate"><span class="pre">BrowserSession.ip_address</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.BrowserSession.location"><code class="docutils literal notranslate"><span class="pre">BrowserSession.location</span></code></a></li>
|
||||
@@ -7363,6 +7820,11 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.updated_at"><code class="docutils literal notranslate"><span class="pre">Endpoint.updated_at</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointAction"><code class="docutils literal notranslate"><span class="pre">EndpointAction</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointAction.config"><code class="docutils literal notranslate"><span class="pre">EndpointAction.config</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointAction.type"><code class="docutils literal notranslate"><span class="pre">EndpointAction.type</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointBackend"><code class="docutils literal notranslate"><span class="pre">EndpointBackend</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointBackend.backend"><code class="docutils literal notranslate"><span class="pre">EndpointBackend.backend</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointBackend.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointBackend.enabled</span></code></a></li>
|
||||
@@ -7511,6 +7973,12 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointOIDC.scopes"><code class="docutils literal notranslate"><span class="pre">EndpointOIDC.scopes</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy"><code class="docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointPolicy.enabled</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy.inbound"><code class="docutils literal notranslate"><span class="pre">EndpointPolicy.inbound</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointPolicy.outbound"><code class="docutils literal notranslate"><span class="pre">EndpointPolicy.outbound</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointRequestHeaders"><code class="docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointRequestHeaders.add"><code class="docutils literal notranslate"><span class="pre">EndpointRequestHeaders.add</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointRequestHeaders.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointRequestHeaders.enabled</span></code></a></li>
|
||||
@@ -7523,6 +7991,12 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointResponseHeaders.remove"><code class="docutils literal notranslate"><span class="pre">EndpointResponseHeaders.remove</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointRule"><code class="docutils literal notranslate"><span class="pre">EndpointRule</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointRule.actions"><code class="docutils literal notranslate"><span class="pre">EndpointRule.actions</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointRule.expressions"><code class="docutils literal notranslate"><span class="pre">EndpointRule.expressions</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointRule.name"><code class="docutils literal notranslate"><span class="pre">EndpointRule.name</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointSAML"><code class="docutils literal notranslate"><span class="pre">EndpointSAML</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointSAML.allow_idp_initiated"><code class="docutils literal notranslate"><span class="pre">EndpointSAML.allow_idp_initiated</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointSAML.assertion_consumer_service_url"><code class="docutils literal notranslate"><span class="pre">EndpointSAML.assertion_consumer_service_url</span></code></a></li>
|
||||
@@ -7565,6 +8039,12 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointTLSTerminationAtEdge.min_version"><code class="docutils literal notranslate"><span class="pre">EndpointTLSTerminationAtEdge.min_version</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointUserAgentFilter"><code class="docutils literal notranslate"><span class="pre">EndpointUserAgentFilter</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointUserAgentFilter.allow"><code class="docutils literal notranslate"><span class="pre">EndpointUserAgentFilter.allow</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointUserAgentFilter.deny"><code class="docutils literal notranslate"><span class="pre">EndpointUserAgentFilter.deny</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointUserAgentFilter.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointUserAgentFilter.enabled</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointWebhookValidation"><code class="docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointWebhookValidation.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointWebhookValidation.enabled</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.EndpointWebhookValidation.provider"><code class="docutils literal notranslate"><span class="pre">EndpointWebhookValidation.provider</span></code></a></li>
|
||||
@@ -7723,11 +8203,13 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.metadata"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.metadata</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.oauth"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.oauth</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.oidc"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.oidc</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.policy"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.policy</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.request_headers"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.request_headers</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.response_headers"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.response_headers</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.saml"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.saml</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.update"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.update()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.uri"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.uri</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.user_agent_filter"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.user_agent_filter</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.webhook_verification"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.webhook_verification</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.HTTPSEdgeRoute.websocket_tcp_converter"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.websocket_tcp_converter</span></code></a></li>
|
||||
</ul>
|
||||
@@ -7943,6 +8425,28 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.SSHUserCertificateList.uri"><code class="docutils literal notranslate"><span class="pre">SSHUserCertificateList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend"><code class="docutils literal notranslate"><span class="pre">StaticBackend</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.address"><code class="docutils literal notranslate"><span class="pre">StaticBackend.address</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.created_at"><code class="docutils literal notranslate"><span class="pre">StaticBackend.created_at</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.delete"><code class="docutils literal notranslate"><span class="pre">StaticBackend.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.description"><code class="docutils literal notranslate"><span class="pre">StaticBackend.description</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.id"><code class="docutils literal notranslate"><span class="pre">StaticBackend.id</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.metadata"><code class="docutils literal notranslate"><span class="pre">StaticBackend.metadata</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.tls"><code class="docutils literal notranslate"><span class="pre">StaticBackend.tls</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.update"><code class="docutils literal notranslate"><span class="pre">StaticBackend.update()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.uri"><code class="docutils literal notranslate"><span class="pre">StaticBackend.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackendList"><code class="docutils literal notranslate"><span class="pre">StaticBackendList</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackendList.backends"><code class="docutils literal notranslate"><span class="pre">StaticBackendList.backends</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackendList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">StaticBackendList.next_page_uri</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackendList.uri"><code class="docutils literal notranslate"><span class="pre">StaticBackendList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackendTLS"><code class="docutils literal notranslate"><span class="pre">StaticBackendTLS</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackendTLS.enabled"><code class="docutils literal notranslate"><span class="pre">StaticBackendTLS.enabled</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TCPEdge"><code class="docutils literal notranslate"><span class="pre">TCPEdge</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TCPEdge.backend"><code class="docutils literal notranslate"><span class="pre">TCPEdge.backend</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TCPEdge.created_at"><code class="docutils literal notranslate"><span class="pre">TCPEdge.created_at</span></code></a></li>
|
||||
@@ -7952,6 +8456,7 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TCPEdge.id"><code class="docutils literal notranslate"><span class="pre">TCPEdge.id</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TCPEdge.ip_restriction"><code class="docutils literal notranslate"><span class="pre">TCPEdge.ip_restriction</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TCPEdge.metadata"><code class="docutils literal notranslate"><span class="pre">TCPEdge.metadata</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TCPEdge.policy"><code class="docutils literal notranslate"><span class="pre">TCPEdge.policy</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TCPEdge.update"><code class="docutils literal notranslate"><span class="pre">TCPEdge.update()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TCPEdge.uri"><code class="docutils literal notranslate"><span class="pre">TCPEdge.uri</span></code></a></li>
|
||||
</ul>
|
||||
@@ -8009,6 +8514,7 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TLSEdge.ip_restriction"><code class="docutils literal notranslate"><span class="pre">TLSEdge.ip_restriction</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TLSEdge.metadata"><code class="docutils literal notranslate"><span class="pre">TLSEdge.metadata</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TLSEdge.mutual_tls"><code class="docutils literal notranslate"><span class="pre">TLSEdge.mutual_tls</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TLSEdge.policy"><code class="docutils literal notranslate"><span class="pre">TLSEdge.policy</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TLSEdge.tls_termination"><code class="docutils literal notranslate"><span class="pre">TLSEdge.tls_termination</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TLSEdge.update"><code class="docutils literal notranslate"><span class="pre">TLSEdge.update()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.TLSEdge.uri"><code class="docutils literal notranslate"><span class="pre">TLSEdge.uri</span></code></a></li>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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 current current-page"><a class="current reference internal" href="#">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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -0,0 +1,397 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TCP Edges" href="edges_tcp.html" /><link rel="prev" title="HTTPS Edge Route User Agent Filter Module" href="edge_route_user_agent_filter_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Policies Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<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="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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="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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="https-edge-route-policies-module">
|
||||
<h1>HTTPS Edge Route Policies Module<a class="headerlink" href="#https-edge-route-policies-module" title="Permalink to this heading">#</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">edge_route_policy_module</span></code> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgeRoutePolicyModuleClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">EdgeRoutePolicyModuleClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgeRoutePolicyModuleClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgeRoutePolicyModuleClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgeRoutePolicyModuleClient.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgeRoutePolicyModuleClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgeRoutePolicyModuleClient.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge</p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge route</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-edge-route-policy-module-delete">https://ngrok.com/docs/api#api-edge-route-policy-module-delete</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgeRoutePolicyModuleClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgeRoutePolicyModuleClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgeRoutePolicyModuleClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge</p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge route</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-edge-route-policy-module-get">https://ngrok.com/docs/api#api-edge-route-policy-module-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgeRoutePolicyModuleClient.replace">
|
||||
<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgeRoutePolicyModuleClient.replace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgeRoutePolicyModuleClient.replace" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-edge-route-policy-module-replace">https://ngrok.com/docs/api#api-edge-route-policy-module-replace</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="edges_tcp.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">TCP Edges</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="edge_route_user_agent_filter_module.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">HTTPS Edge Route User Agent Filter Module</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">HTTPS Edge Route Policies Module</a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.EdgeRoutePolicyModuleClient"><code class="docutils literal notranslate"><span class="pre">EdgeRoutePolicyModuleClient</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.EdgeRoutePolicyModuleClient.delete"><code class="docutils literal notranslate"><span class="pre">EdgeRoutePolicyModuleClient.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.EdgeRoutePolicyModuleClient.get"><code class="docutils literal notranslate"><span class="pre">EdgeRoutePolicyModuleClient.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.EdgeRoutePolicyModuleClient.replace"><code class="docutils literal notranslate"><span class="pre">EdgeRoutePolicyModuleClient.replace()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/scripts/furo.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate" title="ngrok.datatypes.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate" title="ngrok.datatypes.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -0,0 +1,397 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route Policies Module" href="edge_route_policy_module.html" /><link rel="prev" title="HTTPS Edge Route Websocket TCP Converter Module" href="edge_route_websocket_tcp_converter_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route User Agent Filter Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<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="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="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 current current-page"><a class="current reference internal" href="#">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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="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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="https-edge-route-user-agent-filter-module">
|
||||
<h1>HTTPS Edge Route User Agent Filter Module<a class="headerlink" href="#https-edge-route-user-agent-filter-module" title="Permalink to this heading">#</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">edge_route_user_agent_filter_module</span></code> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgeRouteUserAgentFilterModuleClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">EdgeRouteUserAgentFilterModuleClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgeRouteUserAgentFilterModuleClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgeRouteUserAgentFilterModuleClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgeRouteUserAgentFilterModuleClient.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgeRouteUserAgentFilterModuleClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgeRouteUserAgentFilterModuleClient.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge</p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge route</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-delete">https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-delete</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgeRouteUserAgentFilterModuleClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgeRouteUserAgentFilterModuleClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgeRouteUserAgentFilterModuleClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge</p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge route</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-get">https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter" title="ngrok.datatypes.EndpointUserAgentFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointUserAgentFilter</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgeRouteUserAgentFilterModuleClient.replace">
|
||||
<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgeRouteUserAgentFilterModuleClient.replace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgeRouteUserAgentFilterModuleClient.replace" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter" title="ngrok.datatypes.EndpointUserAgentFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointUserAgentFilter</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-replace">https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-replace</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter" title="ngrok.datatypes.EndpointUserAgentFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointUserAgentFilter</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="edge_route_policy_module.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">HTTPS Edge Route Policies Module</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="edge_route_websocket_tcp_converter_module.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">HTTPS Edge Route Websocket TCP Converter Module</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">HTTPS Edge Route User Agent Filter Module</a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.EdgeRouteUserAgentFilterModuleClient"><code class="docutils literal notranslate"><span class="pre">EdgeRouteUserAgentFilterModuleClient</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.EdgeRouteUserAgentFilterModuleClient.delete"><code class="docutils literal notranslate"><span class="pre">EdgeRouteUserAgentFilterModuleClient.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.EdgeRouteUserAgentFilterModuleClient.get"><code class="docutils literal notranslate"><span class="pre">EdgeRouteUserAgentFilterModuleClient.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.EdgeRouteUserAgentFilterModuleClient.replace"><code class="docutils literal notranslate"><span class="pre">EdgeRouteUserAgentFilterModuleClient.replace()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/scripts/furo.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TCP Edges" href="edges_tcp.html" /><link rel="prev" title="HTTPS Edge Route OIDC Module" href="edge_route_oidc_module.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route User Agent Filter Module" href="edge_route_user_agent_filter_module.html" /><link rel="prev" title="HTTPS Edge Route OIDC Module" href="edge_route_oidc_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Websocket TCP Converter Module - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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 current current-page"><a class="current reference internal" href="#">HTTPS Edge Route Websocket TCP Converter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -294,7 +300,7 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebsocketTCPConverter" title="ngrok.datatypes.EndpointWebsocketTCPConverter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebsocketTCPConverter</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebsocketTCPConverter" title="ngrok.datatypes.EndpointWebsocketTCPConverter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebsocketTCPConverter</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -315,12 +321,12 @@
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="edges_tcp.html">
|
||||
<a class="next-page" href="edge_route_user_agent_filter_module.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">TCP Edges</div>
|
||||
<div class="title">HTTPS Edge Route User Agent Filter Module</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
+16
-10
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -262,9 +268,9 @@
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>mutual_tls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – edge modules</p></li>
|
||||
<li><p><strong>tls_termination</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTerminationAtEdge" title="ngrok.datatypes.EndpointTLSTerminationAtEdge"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTerminationAtEdge</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>mutual_tls</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>) – edge modules</p></li>
|
||||
<li><p><strong>tls_termination</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTerminationAtEdge" title="ngrok.datatypes.EndpointTLSTerminationAtEdge"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTerminationAtEdge</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -312,8 +318,8 @@
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -333,11 +339,11 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>mutual_tls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – edge modules</p></li>
|
||||
<li><p><strong>tls_termination</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTerminationAtEdge" title="ngrok.datatypes.EndpointTLSTerminationAtEdge"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTerminationAtEdge</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>mutual_tls</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>) – edge modules</p></li>
|
||||
<li><p><strong>tls_termination</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTerminationAtEdge" title="ngrok.datatypes.EndpointTLSTerminationAtEdge"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTerminationAtEdge</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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 current current-page"><a class="current reference internal" href="#">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -255,7 +261,7 @@
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">EdgesHTTPSRoutesClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesHTTPSRoutesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesHTTPSRoutesClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgesHTTPSRoutesClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">circuit_breaker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">webhook_verification</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">saml</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_tcp_converter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesHTTPSRoutesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesHTTPSRoutesClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">circuit_breaker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">webhook_verification</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">saml</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_tcp_converter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_agent_filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesHTTPSRoutesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesHTTPSRoutesClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create an HTTPS Edge Route</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
@@ -265,17 +271,19 @@
|
||||
<li><p><strong>match</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Route selector: “/blog” or “example.com” or “example.com/blog”</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>backend</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – backend module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – ip restriction module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>circuit_breaker</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – circuit breaker module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>compression</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – compression module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>request_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – request headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>response_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – response headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>webhook_verification</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – webhook verification module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>oauth</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – oauth module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>saml</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate" title="ngrok.datatypes.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – saml module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>oidc</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – oidc module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>websocket_tcp_converter</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebsocketTCPConverter" title="ngrok.datatypes.EndpointWebsocketTCPConverter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebsocketTCPConverter</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – websocket to tcp adapter configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>backend</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>) – backend module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>) – ip restriction module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>circuit_breaker</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>) – circuit breaker module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>compression</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>) – compression module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>request_headers</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>) – request headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>response_headers</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>) – response headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>webhook_verification</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>) – webhook verification module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>oauth</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>) – oauth module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>saml</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate" title="ngrok.datatypes.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>) – saml module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>oidc</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>) – oidc module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>websocket_tcp_converter</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebsocketTCPConverter" title="ngrok.datatypes.EndpointWebsocketTCPConverter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebsocketTCPConverter</span></code></a>) – websocket to tcp adapter configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>user_agent_filter</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter" title="ngrok.datatypes.EndpointUserAgentFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointUserAgentFilter</span></code></a>) – </p></li>
|
||||
<li><p><strong>policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a>) – the traffic policy associated with this edge or null</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -324,7 +332,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgesHTTPSRoutesClient.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">circuit_breaker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">webhook_verification</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">saml</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_tcp_converter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesHTTPSRoutesClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesHTTPSRoutesClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">circuit_breaker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">webhook_verification</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">saml</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_tcp_converter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_agent_filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesHTTPSRoutesClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesHTTPSRoutesClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
@@ -335,17 +343,19 @@
|
||||
<li><p><strong>match</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Route selector: “/blog” or “example.com” or “example.com/blog”</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>backend</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – backend module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – ip restriction module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>circuit_breaker</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – circuit breaker module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>compression</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – compression module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>request_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – request headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>response_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – response headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>webhook_verification</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – webhook verification module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>oauth</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – oauth module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>saml</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate" title="ngrok.datatypes.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – saml module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>oidc</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – oidc module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>websocket_tcp_converter</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebsocketTCPConverter" title="ngrok.datatypes.EndpointWebsocketTCPConverter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebsocketTCPConverter</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – websocket to tcp adapter configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>backend</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>) – backend module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>) – ip restriction module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>circuit_breaker</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>) – circuit breaker module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>compression</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>) – compression module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>request_headers</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>) – request headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>response_headers</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>) – response headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>webhook_verification</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>) – webhook verification module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>oauth</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>) – oauth module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>saml</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate" title="ngrok.datatypes.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>) – saml module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>oidc</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>) – oidc module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>websocket_tcp_converter</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebsocketTCPConverter" title="ngrok.datatypes.EndpointWebsocketTCPConverter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebsocketTCPConverter</span></code></a>) – websocket to tcp adapter configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
|
||||
<li><p><strong>user_agent_filter</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter" title="ngrok.datatypes.EndpointUserAgentFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointUserAgentFilter</span></code></a>) – </p></li>
|
||||
<li><p><strong>policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a>) – the traffic policy associated with this edge or null</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+23
-15
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TCP Edge Backend Module" href="tcp_edge_backend_module.html" /><link rel="prev" title="HTTPS Edge Route Websocket TCP Converter Module" href="edge_route_websocket_tcp_converter_module.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TCP Edge Backend Module" href="tcp_edge_backend_module.html" /><link rel="prev" title="HTTPS Edge Route Policies Module" href="edge_route_policy_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>TCP Edges - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies Module</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -255,16 +261,17 @@
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">EdgesTCPClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTCPClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTCPClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgesTCPClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTCPClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTCPClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTCPClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTCPClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create a TCP Edge</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>backend</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – edge modules</p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>backend</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>) – edge modules</p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>) – </p></li>
|
||||
<li><p><strong>policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a>) – the traffic policy associated with this edge or null</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -312,8 +319,8 @@
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -327,17 +334,18 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgesTCPClient.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTCPClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTCPClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTCPClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTCPClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>backend</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – edge modules</p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>backend</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>) – edge modules</p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>) – </p></li>
|
||||
<li><p><strong>policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a>) – the traffic policy associated with this edge or null</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -367,14 +375,14 @@
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="edge_route_websocket_tcp_converter_module.html">
|
||||
<a class="prev-page" href="edge_route_policy_module.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">HTTPS Edge Route Websocket TCP Converter Module</div>
|
||||
<div class="title">HTTPS Edge Route Policies Module</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
+27
-19
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edge Backend Module" href="tls_edge_backend_module.html" /><link rel="prev" title="TCP Edge IP Restriction Module" href="tcp_edge_ip_restriction_module.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edge Backend Module" href="tls_edge_backend_module.html" /><link rel="prev" title="TCP Edge Policy Module" href="tcp_edge_policy_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>TLS Edges - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy Module</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -255,18 +261,19 @@
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">EdgesTLSClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTLSClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTLSClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgesTLSClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mutual_tls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_termination</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTLSClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTLSClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mutual_tls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_termination</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTLSClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTLSClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create a TLS Edge</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>backend</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – edge modules</p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>mutual_tls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>tls_termination</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>backend</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>) – edge modules</p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>) – </p></li>
|
||||
<li><p><strong>mutual_tls</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>) – </p></li>
|
||||
<li><p><strong>tls_termination</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>) – </p></li>
|
||||
<li><p><strong>policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a>) – the traffic policy associated with this edge or null</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -314,8 +321,8 @@
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -329,19 +336,20 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EdgesTLSClient.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mutual_tls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_termination</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTLSClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTLSClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_restriction</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mutual_tls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_termination</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EdgesTLSClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EdgesTLSClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this edge</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>backend</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – edge modules</p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>mutual_tls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>tls_termination</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this edge will be used for; optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>hostports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – hostports served by this edge</p></li>
|
||||
<li><p><strong>backend</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>) – edge modules</p></li>
|
||||
<li><p><strong>ip_restriction</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>) – </p></li>
|
||||
<li><p><strong>mutual_tls</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>) – </p></li>
|
||||
<li><p><strong>tls_termination</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>) – </p></li>
|
||||
<li><p><strong>policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a>) – the traffic policy associated with this edge or null</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -371,14 +379,14 @@
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="tcp_edge_ip_restriction_module.html">
|
||||
<a class="prev-page" href="tcp_edge_policy_module.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">TCP Edge IP Restriction Module</div>
|
||||
<div class="title">TCP Edge Policy Module</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
+11
-5
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Destinations" href="event_destinations.html" /><link rel="prev" title="TLS Edge TLS Termination Module" href="tls_edge_tls_termination_module.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Destinations" href="event_destinations.html" /><link rel="prev" title="TLS Edge Policy Module" href="tls_edge_policy_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Endpoints - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy Module</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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>
|
||||
@@ -280,8 +286,8 @@ Only active endpoints associated with a tunnel or backend are returned.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -311,14 +317,14 @@ Only active endpoints associated with a tunnel or backend are returned.</p>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="tls_edge_tls_termination_module.html">
|
||||
<a class="prev-page" href="tls_edge_policy_module.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">TLS Edge TLS Termination Module</div>
|
||||
<div class="title">TLS Edge Policy Module</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Event Destinations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
|
||||
@@ -263,7 +269,7 @@
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human-readable description of the Event Destination. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>format</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code class="docutils literal notranslate"><span class="pre">JSON</span></code>.</p></li>
|
||||
<li><p><strong>target</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EventTarget" title="ngrok.datatypes.EventTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTarget</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code class="docutils literal notranslate"><span class="pre">kinesis</span></code>, <code class="docutils literal notranslate"><span class="pre">firehose</span></code>, <code class="docutils literal notranslate"><span class="pre">cloudwatch_logs</span></code>, or <code class="docutils literal notranslate"><span class="pre">s3</span></code>.</p></li>
|
||||
<li><p><strong>target</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EventTarget" title="ngrok.datatypes.EventTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTarget</span></code></a>) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code class="docutils literal notranslate"><span class="pre">kinesis</span></code>, <code class="docutils literal notranslate"><span class="pre">firehose</span></code>, <code class="docutils literal notranslate"><span class="pre">cloudwatch_logs</span></code>, or <code class="docutils literal notranslate"><span class="pre">s3</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -311,8 +317,8 @@
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -332,10 +338,10 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for this Event Destination.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – Human-readable description of the Event Destination. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>format</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code class="docutils literal notranslate"><span class="pre">JSON</span></code>.</p></li>
|
||||
<li><p><strong>target</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EventTarget" title="ngrok.datatypes.EventTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTarget</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code class="docutils literal notranslate"><span class="pre">kinesis</span></code>, <code class="docutils literal notranslate"><span class="pre">firehose</span></code>, <code class="docutils literal notranslate"><span class="pre">cloudwatch_logs</span></code>, or <code class="docutils literal notranslate"><span class="pre">s3</span></code>.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human-readable description of the Event Destination. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>format</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code class="docutils literal notranslate"><span class="pre">JSON</span></code>.</p></li>
|
||||
<li><p><strong>target</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EventTarget" title="ngrok.datatypes.EventTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTarget</span></code></a>) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code class="docutils literal notranslate"><span class="pre">kinesis</span></code>, <code class="docutils literal notranslate"><span class="pre">firehose</span></code>, <code class="docutils literal notranslate"><span class="pre">cloudwatch_logs</span></code>, or <code class="docutils literal notranslate"><span class="pre">s3</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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 current current-page"><a class="current reference internal" href="#">Event Subscriptions</a></li>
|
||||
@@ -311,8 +317,8 @@
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -332,10 +338,10 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for this Event Subscription.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.</p></li>
|
||||
<li><p><strong>sources</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSourceReplace" title="ngrok.datatypes.EventSourceReplace"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSourceReplace</span></code></a>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – Sources containing the types for which this event subscription will trigger</p></li>
|
||||
<li><p><strong>destination_ids</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – A list of Event Destination IDs which should be used for this Event Subscription.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.</p></li>
|
||||
<li><p><strong>sources</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSourceReplace" title="ngrok.datatypes.EventSourceReplace"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSourceReplace</span></code></a>]) – Sources containing the types for which this event subscription will trigger</p></li>
|
||||
<li><p><strong>destination_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – A list of Event Destination IDs which should be used for this Event Subscription.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -314,8 +320,8 @@ the next backend in the list until one is successful.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -335,8 +341,8 @@ the next backend in the list until one is successful.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>backends</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – the ids of the child backends in order</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
+172
-10
@@ -168,8 +168,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -187,14 +189,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -269,6 +275,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.acme_challenge_cname_target">acme_challenge_cname_target (ngrok.datatypes.ReservedDomain property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicyRule.action">action (ngrok.datatypes.IPPolicyRule property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointRule.actions">actions (ngrok.datatypes.EndpointRule property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUser.active">active (ngrok.datatypes.BotUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders.add">add (ngrok.datatypes.EndpointRequestHeaders property)</a>
|
||||
|
||||
@@ -277,6 +287,8 @@
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedAddr.addr">addr (ngrok.datatypes.ReservedAddr property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend.address">address (ngrok.datatypes.StaticBackend property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.agent_ingresses">agent_ingresses (ngrok.Client property)</a>
|
||||
</li>
|
||||
@@ -293,6 +305,8 @@
|
||||
<li><a href="agent_ingresses.html#ngrok.services.AgentIngressesClient">AgentIngressesClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AgentIngressList">AgentIngressList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter.allow">allow (ngrok.datatypes.EndpointUserAgentFilter property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.allow_idp_initiated">allow_idp_initiated (ngrok.datatypes.EndpointSAML property)</a>
|
||||
|
||||
@@ -306,12 +320,12 @@
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.api_keys">api_keys (ngrok.Client property)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey">APIKey (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKeyList">APIKeyList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api_keys.html#ngrok.services.APIKeysClient">APIKeysClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.application_sessions">application_sessions (ngrok.Client property)</a>
|
||||
@@ -402,6 +416,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.FailoverBackendList.backends">(ngrok.datatypes.FailoverBackendList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.HTTPResponseBackendList.backends">(ngrok.datatypes.HTTPResponseBackendList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackendList.backends">(ngrok.datatypes.StaticBackendList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Tunnel.backends">(ngrok.datatypes.Tunnel property)</a>
|
||||
</li>
|
||||
@@ -415,6 +431,18 @@
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.HTTPResponseBackend.body">body (ngrok.datatypes.HTTPResponseBackend property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.bot_users">bot_users (ngrok.Client property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUserList.bot_users">(ngrok.datatypes.BotUserList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUser">BotUser (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUserList">BotUserList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="bot_users.html#ngrok.services.BotUsersClient">BotUsersClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent.browser_name">browser_name (ngrok.datatypes.UserAgent property)</a>
|
||||
</li>
|
||||
@@ -523,6 +551,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.cname_target">cname_target (ngrok.datatypes.ReservedDomain property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.compression">compression (ngrok.datatypes.HTTPSEdgeRoute property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointAction.config">config (ngrok.datatypes.EndpointAction property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuth.cookie_prefix">cookie_prefix (ngrok.datatypes.EndpointOAuth property)</a>
|
||||
|
||||
@@ -542,6 +572,8 @@
|
||||
<li><a href="agent_ingresses.html#ngrok.services.AgentIngressesClient.create">(ngrok.services.AgentIngressesClient method)</a>
|
||||
</li>
|
||||
<li><a href="api_keys.html#ngrok.services.APIKeysClient.create">(ngrok.services.APIKeysClient method)</a>
|
||||
</li>
|
||||
<li><a href="bot_users.html#ngrok.services.BotUsersClient.create">(ngrok.services.BotUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.create">(ngrok.services.CertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -582,6 +614,8 @@
|
||||
<li><a href="ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.create">(ngrok.services.SSHHostCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.create">(ngrok.services.SSHUserCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="static_backends.html#ngrok.services.StaticBackendsClient.create">(ngrok.services.StaticBackendsClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_certificates.html#ngrok.services.TLSCertificatesClient.create">(ngrok.services.TLSCertificatesClient method)</a>
|
||||
</li>
|
||||
@@ -602,6 +636,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.created_at">(ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.created_at">(ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUser.created_at">(ngrok.datatypes.BotUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.created_at">(ngrok.datatypes.CertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -638,6 +674,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificate.created_at">(ngrok.datatypes.SSHHostCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificate.created_at">(ngrok.datatypes.SSHUserCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend.created_at">(ngrok.datatypes.StaticBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdge.created_at">(ngrok.datatypes.TCPEdge property)</a>
|
||||
</li>
|
||||
@@ -690,6 +728,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.delete">(ngrok.datatypes.ApplicationSession method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.delete">(ngrok.datatypes.ApplicationUser method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUser.delete">(ngrok.datatypes.BotUser method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.delete">(ngrok.datatypes.CertificateAuthority method)</a>
|
||||
</li>
|
||||
@@ -724,6 +764,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificate.delete">(ngrok.datatypes.SSHHostCertificate method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificate.delete">(ngrok.datatypes.SSHUserCertificate method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend.delete">(ngrok.datatypes.StaticBackend method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdge.delete">(ngrok.datatypes.TCPEdge method)</a>
|
||||
</li>
|
||||
@@ -742,6 +784,8 @@
|
||||
<li><a href="application_sessions.html#ngrok.services.ApplicationSessionsClient.delete">(ngrok.services.ApplicationSessionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="application_users.html#ngrok.services.ApplicationUsersClient.delete">(ngrok.services.ApplicationUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="bot_users.html#ngrok.services.BotUsersClient.delete">(ngrok.services.BotUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.delete">(ngrok.services.CertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -758,12 +802,16 @@
|
||||
<li><a href="edge_route_o_auth_module.html#ngrok.services.EdgeRouteOAuthModuleClient.delete">(ngrok.services.EdgeRouteOAuthModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_oidc_module.html#ngrok.services.EdgeRouteOIDCModuleClient.delete">(ngrok.services.EdgeRouteOIDCModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient.delete">(ngrok.services.EdgeRoutePolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_request_headers_module.html#ngrok.services.EdgeRouteRequestHeadersModuleClient.delete">(ngrok.services.EdgeRouteRequestHeadersModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_response_headers_module.html#ngrok.services.EdgeRouteResponseHeadersModuleClient.delete">(ngrok.services.EdgeRouteResponseHeadersModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_saml_module.html#ngrok.services.EdgeRouteSAMLModuleClient.delete">(ngrok.services.EdgeRouteSAMLModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient.delete">(ngrok.services.EdgeRouteUserAgentFilterModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_webhook_verification_module.html#ngrok.services.EdgeRouteWebhookVerificationModuleClient.delete">(ngrok.services.EdgeRouteWebhookVerificationModuleClient method)</a>
|
||||
</li>
|
||||
@@ -808,10 +856,14 @@
|
||||
<li><a href="ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.delete">(ngrok.services.SSHHostCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.delete">(ngrok.services.SSHUserCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="static_backends.html#ngrok.services.StaticBackendsClient.delete">(ngrok.services.StaticBackendsClient method)</a>
|
||||
</li>
|
||||
<li><a href="tcp_edge_backend_module.html#ngrok.services.TCPEdgeBackendModuleClient.delete">(ngrok.services.TCPEdgeBackendModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tcp_edge_ip_restriction_module.html#ngrok.services.TCPEdgeIPRestrictionModuleClient.delete">(ngrok.services.TCPEdgeIPRestrictionModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient.delete">(ngrok.services.TCPEdgePolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_certificates.html#ngrok.services.TLSCertificatesClient.delete">(ngrok.services.TLSCertificatesClient method)</a>
|
||||
</li>
|
||||
@@ -820,6 +872,8 @@
|
||||
<li><a href="tls_edge_ip_restriction_module.html#ngrok.services.TLSEdgeIPRestrictionModuleClient.delete">(ngrok.services.TLSEdgeIPRestrictionModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_mutual_tls_module.html#ngrok.services.TLSEdgeMutualTLSModuleClient.delete">(ngrok.services.TLSEdgeMutualTLSModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient.delete">(ngrok.services.TLSEdgePolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_tls_termination_module.html#ngrok.services.TLSEdgeTLSTerminationModuleClient.delete">(ngrok.services.TLSEdgeTLSTerminationModuleClient method)</a>
|
||||
</li>
|
||||
@@ -835,6 +889,8 @@
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.delete_certificate_management_policy">delete_certificate_management_policy() (ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventTargetFirehose.delivery_stream_arn">delivery_stream_arn (ngrok.datatypes.EventTargetFirehose property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter.deny">deny (ngrok.datatypes.EndpointUserAgentFilter property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AgentIngress.description">description (ngrok.datatypes.AgentIngress property)</a>
|
||||
|
||||
@@ -874,6 +930,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificate.description">(ngrok.datatypes.SSHHostCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificate.description">(ngrok.datatypes.SSHUserCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend.description">(ngrok.datatypes.StaticBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdge.description">(ngrok.datatypes.TCPEdge property)</a>
|
||||
</li>
|
||||
@@ -929,12 +987,16 @@
|
||||
<li><a href="edge_route_o_auth_module.html#ngrok.services.EdgeRouteOAuthModuleClient">EdgeRouteOAuthModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_oidc_module.html#ngrok.services.EdgeRouteOIDCModuleClient">EdgeRouteOIDCModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient">EdgeRoutePolicyModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_request_headers_module.html#ngrok.services.EdgeRouteRequestHeadersModuleClient">EdgeRouteRequestHeadersModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_response_headers_module.html#ngrok.services.EdgeRouteResponseHeadersModuleClient">EdgeRouteResponseHeadersModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_saml_module.html#ngrok.services.EdgeRouteSAMLModuleClient">EdgeRouteSAMLModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient">EdgeRouteUserAgentFilterModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_webhook_verification_module.html#ngrok.services.EdgeRouteWebhookVerificationModuleClient">EdgeRouteWebhookVerificationModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
@@ -1008,6 +1070,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuth.enabled">(ngrok.datatypes.EndpointOAuth property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOIDC.enabled">(ngrok.datatypes.EndpointOIDC property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointPolicy.enabled">(ngrok.datatypes.EndpointPolicy property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders.enabled">(ngrok.datatypes.EndpointRequestHeaders property)</a>
|
||||
</li>
|
||||
@@ -1020,10 +1084,14 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointTLSTermination.enabled">(ngrok.datatypes.EndpointTLSTermination property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointTLSTerminationAtEdge.enabled">(ngrok.datatypes.EndpointTLSTerminationAtEdge property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter.enabled">(ngrok.datatypes.EndpointUserAgentFilter property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation.enabled">(ngrok.datatypes.EndpointWebhookValidation property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointWebsocketTCPConverter.enabled">(ngrok.datatypes.EndpointWebsocketTCPConverter property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackendTLS.enabled">(ngrok.datatypes.StaticBackendTLS property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint">Endpoint (class in ngrok.datatypes)</a>
|
||||
@@ -1034,10 +1102,12 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Tunnel.endpoint">(ngrok.datatypes.Tunnel property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointBackend">EndpointBackend (class in ngrok.datatypes)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointAction">EndpointAction (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointBackend">EndpointBackend (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointBackendMutate">EndpointBackendMutate (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker">EndpointCircuitBreaker (class in ngrok.datatypes)</a>
|
||||
@@ -1075,10 +1145,14 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthTwitch">EndpointOAuthTwitch (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOIDC">EndpointOIDC (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointPolicy">EndpointPolicy (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders">EndpointRequestHeaders (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders">EndpointResponseHeaders (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointRule">EndpointRule (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.endpoints">endpoints (ngrok.Client property)</a>
|
||||
|
||||
@@ -1095,6 +1169,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointTLSTermination">EndpointTLSTermination (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointTLSTerminationAtEdge">EndpointTLSTerminationAtEdge (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter">EndpointUserAgentFilter (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation">EndpointWebhookValidation (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
@@ -1159,6 +1235,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventTargetKinesis">EventTargetKinesis (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.expires_at">expires_at (ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointRule.expressions">expressions (ngrok.datatypes.EndpointRule property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.extended_key_usages">extended_key_usages (ngrok.datatypes.CertificateAuthority property)</a>
|
||||
|
||||
@@ -1216,6 +1294,8 @@
|
||||
<li><a href="application_sessions.html#ngrok.services.ApplicationSessionsClient.get">(ngrok.services.ApplicationSessionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="application_users.html#ngrok.services.ApplicationUsersClient.get">(ngrok.services.ApplicationUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="bot_users.html#ngrok.services.BotUsersClient.get">(ngrok.services.BotUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.get">(ngrok.services.CertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -1232,12 +1312,16 @@
|
||||
<li><a href="edge_route_o_auth_module.html#ngrok.services.EdgeRouteOAuthModuleClient.get">(ngrok.services.EdgeRouteOAuthModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_oidc_module.html#ngrok.services.EdgeRouteOIDCModuleClient.get">(ngrok.services.EdgeRouteOIDCModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient.get">(ngrok.services.EdgeRoutePolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_request_headers_module.html#ngrok.services.EdgeRouteRequestHeadersModuleClient.get">(ngrok.services.EdgeRouteRequestHeadersModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_response_headers_module.html#ngrok.services.EdgeRouteResponseHeadersModuleClient.get">(ngrok.services.EdgeRouteResponseHeadersModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_saml_module.html#ngrok.services.EdgeRouteSAMLModuleClient.get">(ngrok.services.EdgeRouteSAMLModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient.get">(ngrok.services.EdgeRouteUserAgentFilterModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_webhook_verification_module.html#ngrok.services.EdgeRouteWebhookVerificationModuleClient.get">(ngrok.services.EdgeRouteWebhookVerificationModuleClient method)</a>
|
||||
</li>
|
||||
@@ -1284,10 +1368,14 @@
|
||||
<li><a href="ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.get">(ngrok.services.SSHHostCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.get">(ngrok.services.SSHUserCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="static_backends.html#ngrok.services.StaticBackendsClient.get">(ngrok.services.StaticBackendsClient method)</a>
|
||||
</li>
|
||||
<li><a href="tcp_edge_backend_module.html#ngrok.services.TCPEdgeBackendModuleClient.get">(ngrok.services.TCPEdgeBackendModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tcp_edge_ip_restriction_module.html#ngrok.services.TCPEdgeIPRestrictionModuleClient.get">(ngrok.services.TCPEdgeIPRestrictionModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient.get">(ngrok.services.TCPEdgePolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_certificates.html#ngrok.services.TLSCertificatesClient.get">(ngrok.services.TLSCertificatesClient method)</a>
|
||||
</li>
|
||||
@@ -1296,6 +1384,8 @@
|
||||
<li><a href="tls_edge_ip_restriction_module.html#ngrok.services.TLSEdgeIPRestrictionModuleClient.get">(ngrok.services.TLSEdgeIPRestrictionModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_mutual_tls_module.html#ngrok.services.TLSEdgeMutualTLSModuleClient.get">(ngrok.services.TLSEdgeMutualTLSModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient.get">(ngrok.services.TLSEdgePolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_tls_termination_module.html#ngrok.services.TLSEdgeTLSTerminationModuleClient.get">(ngrok.services.TLSEdgeTLSTerminationModuleClient method)</a>
|
||||
</li>
|
||||
@@ -1378,6 +1468,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.id">(ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.id">(ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUser.id">(ngrok.datatypes.BotUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.id">(ngrok.datatypes.CertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -1416,6 +1508,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificate.id">(ngrok.datatypes.SSHHostCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificate.id">(ngrok.datatypes.SSHUserCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend.id">(ngrok.datatypes.StaticBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdge.id">(ngrok.datatypes.TCPEdge property)</a>
|
||||
</li>
|
||||
@@ -1436,14 +1530,14 @@
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider">IdentityProvider (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.idp_metadata">idp_metadata (ngrok.datatypes.EndpointSAML property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate.idp_metadata">(ngrok.datatypes.EndpointSAMLMutate property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuth.inactivity_timeout">inactivity_timeout (ngrok.datatypes.EndpointOAuth property)</a>
|
||||
|
||||
<ul>
|
||||
@@ -1454,6 +1548,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate.inactivity_timeout">(ngrok.datatypes.EndpointSAMLMutate property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointPolicy.inbound">inbound (ngrok.datatypes.EndpointPolicy property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AgentIngressList.ingresses">ingresses (ngrok.datatypes.AgentIngressList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSession.ip">ip (ngrok.datatypes.TunnelSession property)</a>
|
||||
@@ -1584,6 +1680,8 @@
|
||||
<li><a href="application_sessions.html#ngrok.services.ApplicationSessionsClient.list">(ngrok.services.ApplicationSessionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="application_users.html#ngrok.services.ApplicationUsersClient.list">(ngrok.services.ApplicationUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="bot_users.html#ngrok.services.BotUsersClient.list">(ngrok.services.BotUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.list">(ngrok.services.CertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -1624,6 +1722,8 @@
|
||||
<li><a href="ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.list">(ngrok.services.SSHHostCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.list">(ngrok.services.SSHUserCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="static_backends.html#ngrok.services.StaticBackendsClient.list">(ngrok.services.StaticBackendsClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_certificates.html#ngrok.services.TLSCertificatesClient.list">(ngrok.services.TLSCertificatesClient method)</a>
|
||||
</li>
|
||||
@@ -1710,6 +1810,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificate.metadata">(ngrok.datatypes.SSHHostCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificate.metadata">(ngrok.datatypes.SSHUserCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend.metadata">(ngrok.datatypes.StaticBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdge.metadata">(ngrok.datatypes.TCPEdge property)</a>
|
||||
</li>
|
||||
@@ -1746,7 +1848,7 @@
|
||||
</li>
|
||||
<li><a href="datatypes.html#module-ngrok.datatypes">ngrok.datatypes</a>
|
||||
</li>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">ngrok.services</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="certificate_authorities.html#module-ngrok.services">[5]</a>, <a href="credentials.html#module-ngrok.services">[6]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[7]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[17]</a>, <a href="edges_https.html#module-ngrok.services">[18]</a>, <a href="edges_https_routes.html#module-ngrok.services">[19]</a>, <a href="edges_tcp.html#module-ngrok.services">[20]</a>, <a href="edges_tls.html#module-ngrok.services">[21]</a>, <a href="endpoints.html#module-ngrok.services">[22]</a>, <a href="event_destinations.html#module-ngrok.services">[23]</a>, <a href="event_sources.html#module-ngrok.services">[24]</a>, <a href="event_subscriptions.html#module-ngrok.services">[25]</a>, <a href="failover_backends.html#module-ngrok.services">[26]</a>, <a href="http_response_backends.html#module-ngrok.services">[27]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[28]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[29]</a>, <a href="ip_policies.html#module-ngrok.services">[30]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[31]</a>, <a href="ip_restrictions.html#module-ngrok.services">[32]</a>, <a href="reserved_addrs.html#module-ngrok.services">[33]</a>, <a href="reserved_domains.html#module-ngrok.services">[34]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[35]</a>, <a href="ssh_credentials.html#module-ngrok.services">[36]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[37]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[38]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[39]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[40]</a>, <a href="tls_certificates.html#module-ngrok.services">[41]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[42]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[43]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[44]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[45]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[46]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[47]</a>, <a href="tunnels.html#module-ngrok.services">[48]</a>, <a href="weighted_backends.html#module-ngrok.services">[49]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">ngrok.services</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[20]</a>, <a href="edges_https.html#module-ngrok.services">[21]</a>, <a href="edges_https_routes.html#module-ngrok.services">[22]</a>, <a href="edges_tcp.html#module-ngrok.services">[23]</a>, <a href="edges_tls.html#module-ngrok.services">[24]</a>, <a href="endpoints.html#module-ngrok.services">[25]</a>, <a href="event_destinations.html#module-ngrok.services">[26]</a>, <a href="event_sources.html#module-ngrok.services">[27]</a>, <a href="event_subscriptions.html#module-ngrok.services">[28]</a>, <a href="failover_backends.html#module-ngrok.services">[29]</a>, <a href="http_response_backends.html#module-ngrok.services">[30]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[31]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[32]</a>, <a href="ip_policies.html#module-ngrok.services">[33]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[34]</a>, <a href="ip_restrictions.html#module-ngrok.services">[35]</a>, <a href="reserved_addrs.html#module-ngrok.services">[36]</a>, <a href="reserved_domains.html#module-ngrok.services">[37]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[38]</a>, <a href="ssh_credentials.html#module-ngrok.services">[39]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[40]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[41]</a>, <a href="static_backends.html#module-ngrok.services">[42]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[43]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[44]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[45]</a>, <a href="tls_certificates.html#module-ngrok.services">[46]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[47]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[48]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[49]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[50]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[51]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[52]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[53]</a>, <a href="tunnels.html#module-ngrok.services">[54]</a>, <a href="weighted_backends.html#module-ngrok.services">[55]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AgentIngressCertJob.msg">msg (ngrok.datatypes.AgentIngressCertJob property)</a>
|
||||
@@ -1772,6 +1874,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.name">name (ngrok.datatypes.ApplicationUser property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUser.name">(ngrok.datatypes.BotUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointRule.name">(ngrok.datatypes.EndpointRule property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider.name">(ngrok.datatypes.IdentityProvider property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
@@ -1789,6 +1895,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSessionList.next_page_uri">(ngrok.datatypes.ApplicationSessionList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUserList.next_page_uri">(ngrok.datatypes.ApplicationUserList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUserList.next_page_uri">(ngrok.datatypes.BotUserList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthorityList.next_page_uri">(ngrok.datatypes.CertificateAuthorityList property)</a>
|
||||
</li>
|
||||
@@ -1823,6 +1931,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificateList.next_page_uri">(ngrok.datatypes.SSHHostCertificateList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificateList.next_page_uri">(ngrok.datatypes.SSHUserCertificateList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackendList.next_page_uri">(ngrok.datatypes.StaticBackendList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdgeList.next_page_uri">(ngrok.datatypes.TCPEdgeList property)</a>
|
||||
</li>
|
||||
@@ -1859,7 +1969,7 @@
|
||||
ngrok.services
|
||||
|
||||
<ul>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="certificate_authorities.html#module-ngrok.services">[5]</a>, <a href="credentials.html#module-ngrok.services">[6]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[7]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[17]</a>, <a href="edges_https.html#module-ngrok.services">[18]</a>, <a href="edges_https_routes.html#module-ngrok.services">[19]</a>, <a href="edges_tcp.html#module-ngrok.services">[20]</a>, <a href="edges_tls.html#module-ngrok.services">[21]</a>, <a href="endpoints.html#module-ngrok.services">[22]</a>, <a href="event_destinations.html#module-ngrok.services">[23]</a>, <a href="event_sources.html#module-ngrok.services">[24]</a>, <a href="event_subscriptions.html#module-ngrok.services">[25]</a>, <a href="failover_backends.html#module-ngrok.services">[26]</a>, <a href="http_response_backends.html#module-ngrok.services">[27]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[28]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[29]</a>, <a href="ip_policies.html#module-ngrok.services">[30]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[31]</a>, <a href="ip_restrictions.html#module-ngrok.services">[32]</a>, <a href="reserved_addrs.html#module-ngrok.services">[33]</a>, <a href="reserved_domains.html#module-ngrok.services">[34]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[35]</a>, <a href="ssh_credentials.html#module-ngrok.services">[36]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[37]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[38]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[39]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[40]</a>, <a href="tls_certificates.html#module-ngrok.services">[41]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[42]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[43]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[44]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[45]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[46]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[47]</a>, <a href="tunnels.html#module-ngrok.services">[48]</a>, <a href="weighted_backends.html#module-ngrok.services">[49]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[20]</a>, <a href="edges_https.html#module-ngrok.services">[21]</a>, <a href="edges_https_routes.html#module-ngrok.services">[22]</a>, <a href="edges_tcp.html#module-ngrok.services">[23]</a>, <a href="edges_tls.html#module-ngrok.services">[24]</a>, <a href="endpoints.html#module-ngrok.services">[25]</a>, <a href="event_destinations.html#module-ngrok.services">[26]</a>, <a href="event_sources.html#module-ngrok.services">[27]</a>, <a href="event_subscriptions.html#module-ngrok.services">[28]</a>, <a href="failover_backends.html#module-ngrok.services">[29]</a>, <a href="http_response_backends.html#module-ngrok.services">[30]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[31]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[32]</a>, <a href="ip_policies.html#module-ngrok.services">[33]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[34]</a>, <a href="ip_restrictions.html#module-ngrok.services">[35]</a>, <a href="reserved_addrs.html#module-ngrok.services">[36]</a>, <a href="reserved_domains.html#module-ngrok.services">[37]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[38]</a>, <a href="ssh_credentials.html#module-ngrok.services">[39]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[40]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[41]</a>, <a href="static_backends.html#module-ngrok.services">[42]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[43]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[44]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[45]</a>, <a href="tls_certificates.html#module-ngrok.services">[46]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[47]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[48]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[49]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[50]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[51]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[52]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[53]</a>, <a href="tunnels.html#module-ngrok.services">[54]</a>, <a href="weighted_backends.html#module-ngrok.services">[55]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.not_after">not_after (ngrok.datatypes.CertificateAuthority property)</a>
|
||||
@@ -1913,6 +2023,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent.os_name">os_name (ngrok.datatypes.UserAgent property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent.os_version">os_version (ngrok.datatypes.UserAgent property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointPolicy.outbound">outbound (ngrok.datatypes.EndpointPolicy property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey.owner_id">owner_id (ngrok.datatypes.APIKey property)</a>
|
||||
|
||||
@@ -1930,6 +2042,14 @@
|
||||
<h2>P</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.policy">policy (ngrok.datatypes.HTTPSEdgeRoute property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdge.policy">(ngrok.datatypes.TCPEdge property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TLSEdge.policy">(ngrok.datatypes.TLSEdge property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificate.principals">principals (ngrok.datatypes.SSHHostCertificate property)</a>
|
||||
|
||||
<ul>
|
||||
@@ -2034,12 +2154,16 @@
|
||||
<li><a href="edge_route_o_auth_module.html#ngrok.services.EdgeRouteOAuthModuleClient.replace">(ngrok.services.EdgeRouteOAuthModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_oidc_module.html#ngrok.services.EdgeRouteOIDCModuleClient.replace">(ngrok.services.EdgeRouteOIDCModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient.replace">(ngrok.services.EdgeRoutePolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_request_headers_module.html#ngrok.services.EdgeRouteRequestHeadersModuleClient.replace">(ngrok.services.EdgeRouteRequestHeadersModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_response_headers_module.html#ngrok.services.EdgeRouteResponseHeadersModuleClient.replace">(ngrok.services.EdgeRouteResponseHeadersModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_saml_module.html#ngrok.services.EdgeRouteSAMLModuleClient.replace">(ngrok.services.EdgeRouteSAMLModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient.replace">(ngrok.services.EdgeRouteUserAgentFilterModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="edge_route_webhook_verification_module.html#ngrok.services.EdgeRouteWebhookVerificationModuleClient.replace">(ngrok.services.EdgeRouteWebhookVerificationModuleClient method)</a>
|
||||
</li>
|
||||
@@ -2052,12 +2176,16 @@
|
||||
<li><a href="tcp_edge_backend_module.html#ngrok.services.TCPEdgeBackendModuleClient.replace">(ngrok.services.TCPEdgeBackendModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tcp_edge_ip_restriction_module.html#ngrok.services.TCPEdgeIPRestrictionModuleClient.replace">(ngrok.services.TCPEdgeIPRestrictionModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient.replace">(ngrok.services.TCPEdgePolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_backend_module.html#ngrok.services.TLSEdgeBackendModuleClient.replace">(ngrok.services.TLSEdgeBackendModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_ip_restriction_module.html#ngrok.services.TLSEdgeIPRestrictionModuleClient.replace">(ngrok.services.TLSEdgeIPRestrictionModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_mutual_tls_module.html#ngrok.services.TLSEdgeMutualTLSModuleClient.replace">(ngrok.services.TLSEdgeMutualTLSModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient.replace">(ngrok.services.TLSEdgePolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_tls_termination_module.html#ngrok.services.TLSEdgeTLSTerminationModuleClient.replace">(ngrok.services.TLSEdgeTLSTerminationModuleClient method)</a>
|
||||
</li>
|
||||
@@ -2194,12 +2322,12 @@
|
||||
</ul></li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient">SSHCertificateAuthoritiesClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority">SSHCertificateAuthority (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthorityList">SSHCertificateAuthorityList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCredential">SSHCredential (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCredentialList">SSHCredentialList (class in ngrok.datatypes)</a>
|
||||
@@ -2228,6 +2356,14 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSession.started_at">(ngrok.datatypes.TunnelSession property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend">StaticBackend (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackendList">StaticBackendList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="static_backends.html#ngrok.services.StaticBackendsClient">StaticBackendsClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackendTLS">StaticBackendTLS (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AbuseReport.status">status (ngrok.datatypes.AbuseReport property)</a>
|
||||
|
||||
<ul>
|
||||
@@ -2279,10 +2415,14 @@
|
||||
<li><a href="tcp_edge_ip_restriction_module.html#ngrok.services.TCPEdgeIPRestrictionModuleClient">TCPEdgeIPRestrictionModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdgeList">TCPEdgeList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient">TCPEdgePolicyModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitHub.teams">teams (ngrok.datatypes.EndpointOAuthGitHub property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointTLSTermination.terminate_at">terminate_at (ngrok.datatypes.EndpointTLSTermination property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend.tls">tls (ngrok.datatypes.StaticBackend property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.tls_certificates">tls_certificates (ngrok.Client property)</a>
|
||||
|
||||
@@ -2316,10 +2456,12 @@
|
||||
</li>
|
||||
<li><a href="tls_edge_mutual_tls_module.html#ngrok.services.TLSEdgeMutualTLSModuleClient">TLSEdgeMutualTLSModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="tls_edge_tls_termination_module.html#ngrok.services.TLSEdgeTLSTerminationModuleClient">TLSEdgeTLSTerminationModuleClient (class in ngrok.services)</a>
|
||||
<li><a href="tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient">TLSEdgePolicyModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="tls_edge_tls_termination_module.html#ngrok.services.TLSEdgeTLSTerminationModuleClient">TLSEdgeTLSTerminationModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey.token">token (ngrok.datatypes.APIKey property)</a>
|
||||
|
||||
<ul>
|
||||
@@ -2371,6 +2513,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.type">type (ngrok.datatypes.Endpoint property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointAction.type">(ngrok.datatypes.EndpointAction property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSource.type">(ngrok.datatypes.EventSource property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSourceReplace.type">(ngrok.datatypes.EventSourceReplace property)</a>
|
||||
@@ -2390,6 +2534,8 @@
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey.update">(ngrok.datatypes.APIKey method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUser.update">(ngrok.datatypes.BotUser method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.update">(ngrok.datatypes.CertificateAuthority method)</a>
|
||||
</li>
|
||||
@@ -2414,6 +2560,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificate.update">(ngrok.datatypes.SSHHostCertificate method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificate.update">(ngrok.datatypes.SSHUserCertificate method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend.update">(ngrok.datatypes.StaticBackend method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdge.update">(ngrok.datatypes.TCPEdge method)</a>
|
||||
</li>
|
||||
@@ -2428,6 +2576,8 @@
|
||||
<li><a href="agent_ingresses.html#ngrok.services.AgentIngressesClient.update">(ngrok.services.AgentIngressesClient method)</a>
|
||||
</li>
|
||||
<li><a href="api_keys.html#ngrok.services.APIKeysClient.update">(ngrok.services.APIKeysClient method)</a>
|
||||
</li>
|
||||
<li><a href="bot_users.html#ngrok.services.BotUsersClient.update">(ngrok.services.BotUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.update">(ngrok.services.CertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -2468,6 +2618,8 @@
|
||||
<li><a href="ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.update">(ngrok.services.SSHHostCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.update">(ngrok.services.SSHUserCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="static_backends.html#ngrok.services.StaticBackendsClient.update">(ngrok.services.StaticBackendsClient method)</a>
|
||||
</li>
|
||||
<li><a href="tls_certificates.html#ngrok.services.TLSCertificatesClient.update">(ngrok.services.TLSCertificatesClient method)</a>
|
||||
</li>
|
||||
@@ -2498,6 +2650,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.uri">(ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUserList.uri">(ngrok.datatypes.ApplicationUserList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUser.uri">(ngrok.datatypes.BotUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUserList.uri">(ngrok.datatypes.BotUserList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.uri">(ngrok.datatypes.CertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -2572,6 +2728,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificate.uri">(ngrok.datatypes.SSHUserCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificateList.uri">(ngrok.datatypes.SSHUserCertificateList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackend.uri">(ngrok.datatypes.StaticBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.StaticBackendList.uri">(ngrok.datatypes.StaticBackendList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TCPEdge.uri">(ngrok.datatypes.TCPEdge property)</a>
|
||||
</li>
|
||||
@@ -2607,6 +2767,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AbuseReport.urls">urls (ngrok.datatypes.AbuseReport property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BrowserSession.user_agent">user_agent (ngrok.datatypes.BrowserSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.user_agent_filter">user_agent_filter (ngrok.datatypes.HTTPSEdgeRoute property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent">UserAgent (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Tunnel Group Backends" href="tunnel_group_backends.html" /><link rel="prev" title="Failover Backends" href="failover_backends.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Static Backends" href="static_backends.html" /><link rel="prev" title="Failover Backends" href="failover_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>HTTP Response Backends - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -263,7 +269,7 @@
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>body</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – body to return as fixed content</p></li>
|
||||
<li><p><strong>headers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – headers to return</p></li>
|
||||
<li><p><strong>status_code</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – status code to return</p></li>
|
||||
<li><p><strong>status_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – status code to return</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -308,8 +314,8 @@
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -328,11 +334,11 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>body</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – body to return as fixed content</p></li>
|
||||
<li><p><strong>headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – headers to return</p></li>
|
||||
<li><p><strong>status_code</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – status code to return</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>body</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – body to return as fixed content</p></li>
|
||||
<li><p><strong>headers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – headers to return</p></li>
|
||||
<li><p><strong>status_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – status code to return</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -353,12 +359,12 @@
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="tunnel_group_backends.html">
|
||||
<a class="next-page" href="static_backends.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Tunnel Group Backends</div>
|
||||
<div class="title">Static Backends</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -287,7 +293,7 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -287,7 +293,7 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTerminationAtEdge" title="ngrok.datatypes.EndpointTLSTerminationAtEdge"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTerminationAtEdge</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTerminationAtEdge" title="ngrok.datatypes.EndpointTLSTerminationAtEdge"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTerminationAtEdge</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+130
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -354,6 +360,7 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.application_sessions"><code class="docutils literal notranslate"><span class="pre">Client.application_sessions</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.application_users"><code class="docutils literal notranslate"><span class="pre">Client.application_users</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.backends"><code class="docutils literal notranslate"><span class="pre">Client.backends</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.bot_users"><code class="docutils literal notranslate"><span class="pre">Client.bot_users</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.certificate_authorities"><code class="docutils literal notranslate"><span class="pre">Client.certificate_authorities</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.credentials"><code class="docutils literal notranslate"><span class="pre">Client.credentials</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.edge_modules"><code class="docutils literal notranslate"><span class="pre">Client.edge_modules</span></code></a></li>
|
||||
@@ -505,6 +512,22 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ApplicationUserList.uri"><code class="docutils literal notranslate"><span class="pre">ApplicationUserList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser"><code class="docutils literal notranslate"><span class="pre">BotUser</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser.active"><code class="docutils literal notranslate"><span class="pre">BotUser.active</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser.created_at"><code class="docutils literal notranslate"><span class="pre">BotUser.created_at</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser.delete"><code class="docutils literal notranslate"><span class="pre">BotUser.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser.id"><code class="docutils literal notranslate"><span class="pre">BotUser.id</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser.name"><code class="docutils literal notranslate"><span class="pre">BotUser.name</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser.update"><code class="docutils literal notranslate"><span class="pre">BotUser.update()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUser.uri"><code class="docutils literal notranslate"><span class="pre">BotUser.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUserList"><code class="docutils literal notranslate"><span class="pre">BotUserList</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUserList.bot_users"><code class="docutils literal notranslate"><span class="pre">BotUserList.bot_users</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUserList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">BotUserList.next_page_uri</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BotUserList.uri"><code class="docutils literal notranslate"><span class="pre">BotUserList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BrowserSession"><code class="docutils literal notranslate"><span class="pre">BrowserSession</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BrowserSession.ip_address"><code class="docutils literal notranslate"><span class="pre">BrowserSession.ip_address</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.BrowserSession.location"><code class="docutils literal notranslate"><span class="pre">BrowserSession.location</span></code></a></li>
|
||||
@@ -568,6 +591,11 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.updated_at"><code class="docutils literal notranslate"><span class="pre">Endpoint.updated_at</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointAction"><code class="docutils literal notranslate"><span class="pre">EndpointAction</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointAction.config"><code class="docutils literal notranslate"><span class="pre">EndpointAction.config</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointAction.type"><code class="docutils literal notranslate"><span class="pre">EndpointAction.type</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackend"><code class="docutils literal notranslate"><span class="pre">EndpointBackend</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackend.backend"><code class="docutils literal notranslate"><span class="pre">EndpointBackend.backend</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackend.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointBackend.enabled</span></code></a></li>
|
||||
@@ -716,6 +744,12 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC.scopes"><code class="docutils literal notranslate"><span class="pre">EndpointOIDC.scopes</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy"><code class="docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointPolicy.enabled</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy.inbound"><code class="docutils literal notranslate"><span class="pre">EndpointPolicy.inbound</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy.outbound"><code class="docutils literal notranslate"><span class="pre">EndpointPolicy.outbound</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders"><code class="docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders.add"><code class="docutils literal notranslate"><span class="pre">EndpointRequestHeaders.add</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointRequestHeaders.enabled</span></code></a></li>
|
||||
@@ -728,6 +762,12 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders.remove"><code class="docutils literal notranslate"><span class="pre">EndpointResponseHeaders.remove</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRule"><code class="docutils literal notranslate"><span class="pre">EndpointRule</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRule.actions"><code class="docutils literal notranslate"><span class="pre">EndpointRule.actions</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRule.expressions"><code class="docutils literal notranslate"><span class="pre">EndpointRule.expressions</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRule.name"><code class="docutils literal notranslate"><span class="pre">EndpointRule.name</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAML"><code class="docutils literal notranslate"><span class="pre">EndpointSAML</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAML.allow_idp_initiated"><code class="docutils literal notranslate"><span class="pre">EndpointSAML.allow_idp_initiated</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAML.assertion_consumer_service_url"><code class="docutils literal notranslate"><span class="pre">EndpointSAML.assertion_consumer_service_url</span></code></a></li>
|
||||
@@ -770,6 +810,12 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTerminationAtEdge.min_version"><code class="docutils literal notranslate"><span class="pre">EndpointTLSTerminationAtEdge.min_version</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter"><code class="docutils literal notranslate"><span class="pre">EndpointUserAgentFilter</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter.allow"><code class="docutils literal notranslate"><span class="pre">EndpointUserAgentFilter.allow</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter.deny"><code class="docutils literal notranslate"><span class="pre">EndpointUserAgentFilter.deny</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointUserAgentFilter.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointUserAgentFilter.enabled</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation"><code class="docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation.enabled"><code class="docutils literal notranslate"><span class="pre">EndpointWebhookValidation.enabled</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation.provider"><code class="docutils literal notranslate"><span class="pre">EndpointWebhookValidation.provider</span></code></a></li>
|
||||
@@ -928,11 +974,13 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.metadata"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.metadata</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.oauth"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.oauth</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.oidc"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.oidc</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.policy"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.policy</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.request_headers"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.request_headers</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.response_headers"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.response_headers</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.saml"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.saml</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.update"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.update()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.uri"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.uri</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.user_agent_filter"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.user_agent_filter</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.webhook_verification"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.webhook_verification</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.websocket_tcp_converter"><code class="docutils literal notranslate"><span class="pre">HTTPSEdgeRoute.websocket_tcp_converter</span></code></a></li>
|
||||
</ul>
|
||||
@@ -1148,6 +1196,28 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHUserCertificateList.uri"><code class="docutils literal notranslate"><span class="pre">SSHUserCertificateList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend"><code class="docutils literal notranslate"><span class="pre">StaticBackend</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.address"><code class="docutils literal notranslate"><span class="pre">StaticBackend.address</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.created_at"><code class="docutils literal notranslate"><span class="pre">StaticBackend.created_at</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.delete"><code class="docutils literal notranslate"><span class="pre">StaticBackend.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.description"><code class="docutils literal notranslate"><span class="pre">StaticBackend.description</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.id"><code class="docutils literal notranslate"><span class="pre">StaticBackend.id</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.metadata"><code class="docutils literal notranslate"><span class="pre">StaticBackend.metadata</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.tls"><code class="docutils literal notranslate"><span class="pre">StaticBackend.tls</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.update"><code class="docutils literal notranslate"><span class="pre">StaticBackend.update()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.uri"><code class="docutils literal notranslate"><span class="pre">StaticBackend.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackendList"><code class="docutils literal notranslate"><span class="pre">StaticBackendList</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackendList.backends"><code class="docutils literal notranslate"><span class="pre">StaticBackendList.backends</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackendList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">StaticBackendList.next_page_uri</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackendList.uri"><code class="docutils literal notranslate"><span class="pre">StaticBackendList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackendTLS"><code class="docutils literal notranslate"><span class="pre">StaticBackendTLS</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackendTLS.enabled"><code class="docutils literal notranslate"><span class="pre">StaticBackendTLS.enabled</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TCPEdge"><code class="docutils literal notranslate"><span class="pre">TCPEdge</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TCPEdge.backend"><code class="docutils literal notranslate"><span class="pre">TCPEdge.backend</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TCPEdge.created_at"><code class="docutils literal notranslate"><span class="pre">TCPEdge.created_at</span></code></a></li>
|
||||
@@ -1157,6 +1227,7 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TCPEdge.id"><code class="docutils literal notranslate"><span class="pre">TCPEdge.id</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TCPEdge.ip_restriction"><code class="docutils literal notranslate"><span class="pre">TCPEdge.ip_restriction</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TCPEdge.metadata"><code class="docutils literal notranslate"><span class="pre">TCPEdge.metadata</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TCPEdge.policy"><code class="docutils literal notranslate"><span class="pre">TCPEdge.policy</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TCPEdge.update"><code class="docutils literal notranslate"><span class="pre">TCPEdge.update()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TCPEdge.uri"><code class="docutils literal notranslate"><span class="pre">TCPEdge.uri</span></code></a></li>
|
||||
</ul>
|
||||
@@ -1214,6 +1285,7 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSEdge.ip_restriction"><code class="docutils literal notranslate"><span class="pre">TLSEdge.ip_restriction</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSEdge.metadata"><code class="docutils literal notranslate"><span class="pre">TLSEdge.metadata</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSEdge.mutual_tls"><code class="docutils literal notranslate"><span class="pre">TLSEdge.mutual_tls</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSEdge.policy"><code class="docutils literal notranslate"><span class="pre">TLSEdge.policy</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSEdge.tls_termination"><code class="docutils literal notranslate"><span class="pre">TLSEdge.tls_termination</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSEdge.update"><code class="docutils literal notranslate"><span class="pre">TLSEdge.update()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSEdge.uri"><code class="docutils literal notranslate"><span class="pre">TLSEdge.uri</span></code></a></li>
|
||||
@@ -1408,6 +1480,17 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="static_backends.html">Static Backends</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="static_backends.html#ngrok.services.StaticBackendsClient"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="static_backends.html#ngrok.services.StaticBackendsClient.create"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.create()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="static_backends.html#ngrok.services.StaticBackendsClient.delete"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="static_backends.html#ngrok.services.StaticBackendsClient.get"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.get()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="static_backends.html#ngrok.services.StaticBackendsClient.list"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.list()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="static_backends.html#ngrok.services.StaticBackendsClient.update"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tunnel_group_backends.html#ngrok.services.TunnelGroupBackendsClient"><code class="docutils literal notranslate"><span class="pre">TunnelGroupBackendsClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tunnel_group_backends.html#ngrok.services.TunnelGroupBackendsClient.create"><code class="docutils literal notranslate"><span class="pre">TunnelGroupBackendsClient.create()</span></code></a></li>
|
||||
@@ -1430,6 +1513,17 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bot_users.html">Bot Users</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient"><code class="docutils literal notranslate"><span class="pre">BotUsersClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient.create"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.create()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient.delete"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient.get"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.get()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient.list"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.list()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient.update"><code class="docutils literal notranslate"><span class="pre">BotUsersClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient"><code class="docutils literal notranslate"><span class="pre">CertificateAuthoritiesClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.create"><code class="docutils literal notranslate"><span class="pre">CertificateAuthoritiesClient.create()</span></code></a></li>
|
||||
@@ -1590,6 +1684,24 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient"><code class="docutils literal notranslate"><span class="pre">EdgeRouteUserAgentFilterModuleClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient.delete"><code class="docutils literal notranslate"><span class="pre">EdgeRouteUserAgentFilterModuleClient.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient.get"><code class="docutils literal notranslate"><span class="pre">EdgeRouteUserAgentFilterModuleClient.get()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="edge_route_user_agent_filter_module.html#ngrok.services.EdgeRouteUserAgentFilterModuleClient.replace"><code class="docutils literal notranslate"><span class="pre">EdgeRouteUserAgentFilterModuleClient.replace()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies Module</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient"><code class="docutils literal notranslate"><span class="pre">EdgeRoutePolicyModuleClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient.delete"><code class="docutils literal notranslate"><span class="pre">EdgeRoutePolicyModuleClient.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient.get"><code class="docutils literal notranslate"><span class="pre">EdgeRoutePolicyModuleClient.get()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="edge_route_policy_module.html#ngrok.services.EdgeRoutePolicyModuleClient.replace"><code class="docutils literal notranslate"><span class="pre">EdgeRoutePolicyModuleClient.replace()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="edges_tcp.html#ngrok.services.EdgesTCPClient"><code class="docutils literal notranslate"><span class="pre">EdgesTCPClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="edges_tcp.html#ngrok.services.EdgesTCPClient.create"><code class="docutils literal notranslate"><span class="pre">EdgesTCPClient.create()</span></code></a></li>
|
||||
@@ -1619,6 +1731,15 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_policy_module.html">TCP Edge Policy Module</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient"><code class="docutils literal notranslate"><span class="pre">TCPEdgePolicyModuleClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient.delete"><code class="docutils literal notranslate"><span class="pre">TCPEdgePolicyModuleClient.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient.get"><code class="docutils literal notranslate"><span class="pre">TCPEdgePolicyModuleClient.get()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tcp_edge_policy_module.html#ngrok.services.TCPEdgePolicyModuleClient.replace"><code class="docutils literal notranslate"><span class="pre">TCPEdgePolicyModuleClient.replace()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="edges_tls.html#ngrok.services.EdgesTLSClient"><code class="docutils literal notranslate"><span class="pre">EdgesTLSClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="edges_tls.html#ngrok.services.EdgesTLSClient.create"><code class="docutils literal notranslate"><span class="pre">EdgesTLSClient.create()</span></code></a></li>
|
||||
@@ -1666,6 +1787,15 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_policy_module.html">TLS Edge Policy Module</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient"><code class="docutils literal notranslate"><span class="pre">TLSEdgePolicyModuleClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient.delete"><code class="docutils literal notranslate"><span class="pre">TLSEdgePolicyModuleClient.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient.get"><code class="docutils literal notranslate"><span class="pre">TLSEdgePolicyModuleClient.get()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tls_edge_policy_module.html#ngrok.services.TLSEdgePolicyModuleClient.replace"><code class="docutils literal notranslate"><span class="pre">TLSEdgePolicyModuleClient.replace()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient"><code class="docutils literal notranslate"><span class="pre">EndpointsClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient.get"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.get()</span></code></a></li>
|
||||
|
||||
+10
-4
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -313,8 +319,8 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.</
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -334,8 +340,8 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.</
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of the source IPs of this IP policy. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of the source IPs of this IP policy. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -314,8 +320,8 @@ make up an IP Policy.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -335,9 +341,9 @@ make up an IP Policy.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of the source IPs of this IP rule. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>cidr</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of the source IPs of this IP rule. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>cidr</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -318,8 +324,8 @@ public-facing endpoints.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -339,9 +345,9 @@ public-facing endpoints.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this IP restriction. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>enforced</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – true if the IP restriction will be enforced. if false, only warnings will be issued</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this IP restriction. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>enforced</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – true if the IP restriction will be enforced. if false, only warnings will be issued</p></li>
|
||||
<li><p><strong>ip_policy_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – the set of IP policy identifiers that are used to enforce the restriction</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
Binary file not shown.
@@ -168,8 +168,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -187,14 +189,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -313,8 +319,8 @@ chosen.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -334,8 +340,8 @@ chosen.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of what this reserved address will be used for</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this reserved address will be used for</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -265,11 +271,11 @@ This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – hostname of the reserved domain</p></li>
|
||||
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p></li>
|
||||
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this reserved domain will be used for</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>certificate_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_management_policy</span></code>.</p></li>
|
||||
<li><p><strong>certificate_management_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomainCertPolicy" title="ngrok.datatypes.ReservedDomainCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertPolicy</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_id</span></code>.</p></li>
|
||||
<li><p><strong>certificate_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_management_policy</span></code>.</p></li>
|
||||
<li><p><strong>certificate_management_policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomainCertPolicy" title="ngrok.datatypes.ReservedDomainCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertPolicy</span></code></a>) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_id</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -341,8 +347,8 @@ This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -362,10 +368,10 @@ This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of what this reserved domain will be used for</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>certificate_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_management_policy</span></code>.</p></li>
|
||||
<li><p><strong>certificate_management_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomainCertPolicy" title="ngrok.datatypes.ReservedDomainCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertPolicy</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_id</span></code>.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this reserved domain will be used for</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>certificate_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_management_policy</span></code>.</p></li>
|
||||
<li><p><strong>certificate_management_policy</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomainCertPolicy" title="ngrok.datatypes.ReservedDomainCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertPolicy</span></code></a>) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_id</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -167,8 +167,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -186,14 +188,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -314,8 +320,8 @@ key that can be used to sign other SSH host and user certificates.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -335,8 +341,8 @@ key that can be used to sign other SSH host and user certificates.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this SSH Certificate Authority. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this SSH Certificate Authority. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -266,7 +272,7 @@ via the ngrok SSH tunnel gateway.</p>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>public_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the PEM-encoded public key of the SSH keypair that will be used to authenticate</p></li>
|
||||
<li><p><strong>owner_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
|
||||
<li><p><strong>owner_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -314,8 +320,8 @@ via the ngrok SSH tunnel gateway.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -335,9 +341,9 @@ via the ngrok SSH tunnel gateway.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -317,8 +323,8 @@ SSH Certificate Authority that was used to sign the certificate.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -338,8 +344,8 @@ SSH Certificate Authority that was used to sign the certificate.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this SSH Host Certificate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this SSH Host Certificate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -320,8 +326,8 @@ Certificate Authority used to sign the certificate.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -341,8 +347,8 @@ Certificate Authority used to sign the certificate.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this SSH User Certificate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this SSH User Certificate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -0,0 +1,442 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Tunnel Group Backends" href="tunnel_group_backends.html" /><link rel="prev" title="HTTP Response Backends" href="http_response_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Static Backends - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<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="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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 current current-page"><a class="current reference internal" href="#">Static 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="bot_users.html">Bot Users</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="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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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="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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="static-backends">
|
||||
<h1>Static Backends<a class="headerlink" href="#static-backends" title="Permalink to this heading">#</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">static_backends</span></code> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.services.StaticBackendsClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">StaticBackendsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#StaticBackendsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.StaticBackendsClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>A static backend sends traffic to a TCP address (hostname and port) that
|
||||
is reachable on the public internet.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.StaticBackendsClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#StaticBackendsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.StaticBackendsClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create a new static backend</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the address to forward to</p></li>
|
||||
<li><p><strong>tls</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackendTLS" title="ngrok.datatypes.StaticBackendTLS"><code class="xref py py-class docutils literal notranslate"><span class="pre">StaticBackendTLS</span></code></a>) – tls configuration to use</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-static-backends-create">https://ngrok.com/docs/api#api-static-backends-create</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend" title="ngrok.datatypes.StaticBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">StaticBackend</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.StaticBackendsClient.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#StaticBackendsClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.StaticBackendsClient.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Delete a static backend by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-static-backends-delete">https://ngrok.com/docs/api#api-static-backends-delete</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.StaticBackendsClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#StaticBackendsClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.StaticBackendsClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Get detailed information about a static backend by ID</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-static-backends-get">https://ngrok.com/docs/api#api-static-backends-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend" title="ngrok.datatypes.StaticBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">StaticBackend</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.StaticBackendsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#StaticBackendsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.StaticBackendsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all static backends on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-static-backends-list">https://ngrok.com/docs/api#api-static-backends-list</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackendList" title="ngrok.datatypes.StaticBackendList"><code class="xref py py-class docutils literal notranslate"><span class="pre">StaticBackendList</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.StaticBackendsClient.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#StaticBackendsClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.StaticBackendsClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Update static backend by ID</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the address to forward to</p></li>
|
||||
<li><p><strong>tls</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackendTLS" title="ngrok.datatypes.StaticBackendTLS"><code class="xref py py-class docutils literal notranslate"><span class="pre">StaticBackendTLS</span></code></a>) – tls configuration to use</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-static-backends-update">https://ngrok.com/docs/api#api-static-backends-update</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend" title="ngrok.datatypes.StaticBackend"><code class="xref py py-class docutils literal notranslate"><span class="pre">StaticBackend</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="tunnel_group_backends.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Tunnel Group Backends</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="http_response_backends.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">HTTP Response Backends</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Static Backends</a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.StaticBackendsClient"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.StaticBackendsClient.create"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.create()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.StaticBackendsClient.delete"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.StaticBackendsClient.get"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.StaticBackendsClient.list"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.list()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.StaticBackendsClient.update"><code class="docutils literal notranslate"><span class="pre">StaticBackendsClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/scripts/furo.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -287,7 +293,7 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edges" href="edges_tls.html" /><link rel="prev" title="TCP Edge Backend Module" href="tcp_edge_backend_module.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TCP Edge Policy Module" href="tcp_edge_policy_module.html" /><link rel="prev" title="TCP Edge Backend Module" href="tcp_edge_backend_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>TCP Edge IP Restriction Module - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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 current current-page"><a class="current reference internal" href="#">TCP Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -287,7 +293,7 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -308,12 +314,12 @@
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="edges_tls.html">
|
||||
<a class="next-page" href="tcp_edge_policy_module.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">TLS Edges</div>
|
||||
<div class="title">TCP Edge Policy Module</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@@ -0,0 +1,390 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edges" href="edges_tls.html" /><link rel="prev" title="TCP Edge IP Restriction Module" href="tcp_edge_ip_restriction_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>TCP Edge Policy Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<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="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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 current current-page"><a class="current reference internal" href="#">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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="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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="tcp-edge-policy-module">
|
||||
<h1>TCP Edge Policy Module<a class="headerlink" href="#tcp-edge-policy-module" title="Permalink to this heading">#</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">tcp_edge_policy_module</span></code> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TCPEdgePolicyModuleClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">TCPEdgePolicyModuleClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TCPEdgePolicyModuleClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TCPEdgePolicyModuleClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TCPEdgePolicyModuleClient.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TCPEdgePolicyModuleClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TCPEdgePolicyModuleClient.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tcp-edge-policy-module-delete">https://ngrok.com/docs/api#api-tcp-edge-policy-module-delete</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TCPEdgePolicyModuleClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TCPEdgePolicyModuleClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TCPEdgePolicyModuleClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tcp-edge-policy-module-get">https://ngrok.com/docs/api#api-tcp-edge-policy-module-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TCPEdgePolicyModuleClient.replace">
|
||||
<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TCPEdgePolicyModuleClient.replace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TCPEdgePolicyModuleClient.replace" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tcp-edge-policy-module-replace">https://ngrok.com/docs/api#api-tcp-edge-policy-module-replace</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="edges_tls.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">TLS Edges</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="tcp_edge_ip_restriction_module.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">TCP Edge IP Restriction Module</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">TCP Edge Policy Module</a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.TCPEdgePolicyModuleClient"><code class="docutils literal notranslate"><span class="pre">TCPEdgePolicyModuleClient</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.TCPEdgePolicyModuleClient.delete"><code class="docutils literal notranslate"><span class="pre">TCPEdgePolicyModuleClient.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.TCPEdgePolicyModuleClient.get"><code class="docutils literal notranslate"><span class="pre">TCPEdgePolicyModuleClient.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.TCPEdgePolicyModuleClient.replace"><code class="docutils literal notranslate"><span class="pre">TCPEdgePolicyModuleClient.replace()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/scripts/furo.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -316,8 +322,8 @@ automated certificate provisioning.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -337,8 +343,8 @@ automated certificate provisioning.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this TLS certificate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this TLS certificate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -287,7 +293,7 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackendMutate" title="ngrok.datatypes.EndpointBackendMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointBackendMutate</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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 current current-page"><a class="current reference internal" href="#">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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -287,7 +293,7 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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 current current-page"><a class="current reference internal" href="#">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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -287,7 +293,7 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -0,0 +1,390 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Endpoints" href="endpoints.html" /><link rel="prev" title="TLS Edge TLS Termination Module" href="tls_edge_tls_termination_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>TLS Edge Policy Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<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="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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 current current-page"><a class="current reference internal" href="#">TLS Edge Policy 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="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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="tls-edge-policy-module">
|
||||
<h1>TLS Edge Policy Module<a class="headerlink" href="#tls-edge-policy-module" title="Permalink to this heading">#</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">tls_edge_policy_module</span></code> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TLSEdgePolicyModuleClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">TLSEdgePolicyModuleClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TLSEdgePolicyModuleClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TLSEdgePolicyModuleClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TLSEdgePolicyModuleClient.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TLSEdgePolicyModuleClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TLSEdgePolicyModuleClient.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tls-edge-policy-module-delete">https://ngrok.com/docs/api#api-tls-edge-policy-module-delete</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TLSEdgePolicyModuleClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TLSEdgePolicyModuleClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TLSEdgePolicyModuleClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tls-edge-policy-module-get">https://ngrok.com/docs/api#api-tls-edge-policy-module-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TLSEdgePolicyModuleClient.replace">
|
||||
<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TLSEdgePolicyModuleClient.replace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TLSEdgePolicyModuleClient.replace" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tls-edge-policy-module-replace">https://ngrok.com/docs/api#api-tls-edge-policy-module-replace</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointPolicy" title="ngrok.datatypes.EndpointPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointPolicy</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="endpoints.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Endpoints</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="tls_edge_tls_termination_module.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">TLS Edge TLS Termination Module</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">TLS Edge Policy Module</a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.TLSEdgePolicyModuleClient"><code class="docutils literal notranslate"><span class="pre">TLSEdgePolicyModuleClient</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.TLSEdgePolicyModuleClient.delete"><code class="docutils literal notranslate"><span class="pre">TLSEdgePolicyModuleClient.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.TLSEdgePolicyModuleClient.get"><code class="docutils literal notranslate"><span class="pre">TLSEdgePolicyModuleClient.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.TLSEdgePolicyModuleClient.replace"><code class="docutils literal notranslate"><span class="pre">TLSEdgePolicyModuleClient.replace()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/scripts/furo.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Endpoints" href="endpoints.html" /><link rel="prev" title="TLS Edge Mutual TLS Module" href="tls_edge_mutual_tls_module.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edge Policy Module" href="tls_edge_policy_module.html" /><link rel="prev" title="TLS Edge Mutual TLS Module" href="tls_edge_mutual_tls_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>TLS Edge TLS Termination Module - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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 current current-page"><a class="current reference internal" href="#">TLS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -287,7 +293,7 @@
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>module</strong> (<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -308,12 +314,12 @@
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="endpoints.html">
|
||||
<a class="next-page" href="tls_edge_policy_module.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Endpoints</div>
|
||||
<div class="title">TLS Edge Policy Module</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Weighted Backends" href="weighted_backends.html" /><link rel="prev" title="HTTP Response Backends" href="http_response_backends.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Weighted Backends" href="weighted_backends.html" /><link rel="prev" title="Static Backends" href="static_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Tunnel Group Backends - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static Backends</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -312,8 +318,8 @@ a label selector.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -333,8 +339,8 @@ a label selector.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>labels</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – labels to watch for tunnels on, e.g. app->foo, dc->bar</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
@@ -365,14 +371,14 @@ a label selector.</p>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="http_response_backends.html">
|
||||
<a class="prev-page" href="static_backends.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">HTTP Response Backends</div>
|
||||
<div class="title">Static Backends</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -280,8 +286,8 @@ session can include one or more Tunnels.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+8
-2
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -279,8 +285,8 @@ agent tunnel session or an SSH reverse tunnel session.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<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="Tunnel Group Backends" href="tunnel_group_backends.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Bot Users" href="bot_users.html" /><link rel="prev" title="Tunnel Group Backends" href="tunnel_group_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Weighted Backends - ngrok-api documentation</title>
|
||||
@@ -170,8 +170,10 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</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="static_backends.html">Static 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 current current-page"><a class="current reference internal" href="#">Weighted Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bot_users.html">Bot Users</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="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
@@ -189,14 +191,18 @@
|
||||
<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="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_policy_module.html">HTTPS Edge Route Policies 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="tcp_edge_policy_module.html">TCP Edge Policy 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="tls_edge_policy_module.html">TLS Edge Policy 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>
|
||||
@@ -314,8 +320,8 @@ weights.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – </p></li>
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -335,8 +341,8 @@ weights.</p>
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this backend. Optional</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this backend. Optional</p></li>
|
||||
<li><p><strong>backends</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>]) – the ids of the child backends to their weights [0-10000]</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
@@ -358,12 +364,12 @@ weights.</p>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="certificate_authorities.html">
|
||||
<a class="next-page" href="bot_users.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Certificate Authorities</div>
|
||||
<div class="title">Bot Users</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@@ -45,6 +45,10 @@ class Client(object):
|
||||
session can include one or more Tunnels."""
|
||||
return TunnelSessionsClient(self)
|
||||
|
||||
@property
|
||||
def bot_users(self) -> BotUsersClient:
|
||||
return BotUsersClient(self)
|
||||
|
||||
@property
|
||||
def certificate_authorities(self) -> CertificateAuthoritiesClient:
|
||||
"""Certificate Authorities are x509 certificates that are used to sign other
|
||||
@@ -168,6 +172,7 @@ class Client(object):
|
||||
[
|
||||
"failover",
|
||||
"http_response",
|
||||
"static_address",
|
||||
"tunnel_group",
|
||||
"weighted",
|
||||
],
|
||||
@@ -175,6 +180,7 @@ class Client(object):
|
||||
return ns(
|
||||
failover=FailoverBackendsClient(self),
|
||||
http_response=HTTPResponseBackendsClient(self),
|
||||
static_address=StaticBackendsClient(self),
|
||||
tunnel_group=TunnelGroupBackendsClient(self),
|
||||
weighted=WeightedBackendsClient(self),
|
||||
)
|
||||
@@ -215,6 +221,7 @@ class Client(object):
|
||||
"https_edge_route_saml",
|
||||
"https_edge_route_oidc",
|
||||
"https_edge_route_websocket_tcp_converter",
|
||||
"https_edge_route_user_agent_filter",
|
||||
"tcp_edge_backend",
|
||||
"tcp_edge_ip_restriction",
|
||||
"tls_edge_backend",
|
||||
@@ -243,6 +250,9 @@ class Client(object):
|
||||
https_edge_route_websocket_tcp_converter=EdgeRouteWebsocketTCPConverterModuleClient(
|
||||
self
|
||||
),
|
||||
https_edge_route_user_agent_filter=EdgeRouteUserAgentFilterModuleClient(
|
||||
self
|
||||
),
|
||||
tcp_edge_backend=TCPEdgeBackendModuleClient(self),
|
||||
tcp_edge_ip_restriction=TCPEdgeIPRestrictionModuleClient(self),
|
||||
tls_edge_backend=TLSEdgeBackendModuleClient(self),
|
||||
|
||||
+408
-3
@@ -1161,6 +1161,141 @@ class HTTPResponseBackendList(object):
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class StaticBackend(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["tls"] = (
|
||||
StaticBackendTLS(client, props["tls"])
|
||||
if props.get("tls") is not None
|
||||
else None
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<StaticBackend {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<StaticBackend {}>".format(repr(self._props))
|
||||
|
||||
def delete(
|
||||
self,
|
||||
):
|
||||
self._client.backends.static_address.delete(
|
||||
id=self.id,
|
||||
)
|
||||
|
||||
def update(
|
||||
self,
|
||||
description: str = None,
|
||||
metadata: str = None,
|
||||
address: str = "",
|
||||
tls: StaticBackendTLS = None,
|
||||
):
|
||||
self._client.backends.static_address.update(
|
||||
id=self.id,
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
address=address,
|
||||
tls=tls,
|
||||
)
|
||||
|
||||
@property
|
||||
def id(self) -> str:
|
||||
"""unique identifier for this static backend"""
|
||||
return self._props["id"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of the StaticBackend API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def created_at(self) -> datetime:
|
||||
"""timestamp when the backend was created, RFC 3339 format"""
|
||||
return self._props["created_at"]
|
||||
|
||||
@property
|
||||
def description(self) -> str:
|
||||
"""human-readable description of this backend. Optional"""
|
||||
return self._props["description"]
|
||||
|
||||
@property
|
||||
def metadata(self) -> str:
|
||||
"""arbitrary user-defined machine-readable data of this backend. Optional"""
|
||||
return self._props["metadata"]
|
||||
|
||||
@property
|
||||
def address(self) -> str:
|
||||
"""the address to forward to"""
|
||||
return self._props["address"]
|
||||
|
||||
@property
|
||||
def tls(self) -> StaticBackendTLS:
|
||||
"""tls configuration to use"""
|
||||
return self._props["tls"]
|
||||
|
||||
|
||||
class StaticBackendTLS(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<StaticBackendTLS {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<StaticBackendTLS {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def enabled(self) -> bool:
|
||||
"""if TLS is checked"""
|
||||
return self._props["enabled"]
|
||||
|
||||
|
||||
class StaticBackendList(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["backends"] = (
|
||||
[StaticBackend(client, x) for x in props["backends"]]
|
||||
if props.get("backends") is not None
|
||||
else []
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<StaticBackendList {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<StaticBackendList {}>".format(repr(self._props))
|
||||
|
||||
def __iter__(self):
|
||||
return PagedIterator(self._client, self, "backends")
|
||||
|
||||
@property
|
||||
def backends(self) -> Sequence[StaticBackend]:
|
||||
"""the list of all static backends on this account"""
|
||||
return self._props["backends"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of the static backends list API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def next_page_uri(self) -> str:
|
||||
"""URI of the next page, or null if there is no next page"""
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class TunnelGroupBackend(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
@@ -1377,6 +1512,102 @@ class WeightedBackendList(object):
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class BotUser(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<BotUser {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<BotUser {}>".format(repr(self._props))
|
||||
|
||||
def delete(
|
||||
self,
|
||||
):
|
||||
self._client.bot_users.delete(
|
||||
id=self.id,
|
||||
)
|
||||
|
||||
def update(
|
||||
self,
|
||||
name: str = None,
|
||||
active: bool = None,
|
||||
):
|
||||
self._client.bot_users.update(
|
||||
id=self.id,
|
||||
name=name,
|
||||
active=active,
|
||||
)
|
||||
|
||||
@property
|
||||
def id(self) -> str:
|
||||
"""unique API key resource identifier"""
|
||||
return self._props["id"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI to the API resource of this bot user"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def name(self) -> str:
|
||||
"""human-readable name used to identify the bot"""
|
||||
return self._props["name"]
|
||||
|
||||
@property
|
||||
def active(self) -> bool:
|
||||
"""whether or not the bot is active"""
|
||||
return self._props["active"]
|
||||
|
||||
@property
|
||||
def created_at(self) -> datetime:
|
||||
"""timestamp when the api key was created, RFC 3339 format"""
|
||||
return self._props["created_at"]
|
||||
|
||||
|
||||
class BotUserList(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["bot_users"] = (
|
||||
[BotUser(client, x) for x in props["bot_users"]]
|
||||
if props.get("bot_users") is not None
|
||||
else []
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<BotUserList {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<BotUserList {}>".format(repr(self._props))
|
||||
|
||||
def __iter__(self):
|
||||
return PagedIterator(self._client, self, "bot_users")
|
||||
|
||||
@property
|
||||
def bot_users(self) -> Sequence[BotUser]:
|
||||
"""the list of all bot users on this account"""
|
||||
return self._props["bot_users"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of the bot users list API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def next_page_uri(self) -> str:
|
||||
"""URI of the next page, or null if there is no next page"""
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class CertificateAuthority(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
@@ -1639,7 +1870,7 @@ class EndpointWebhookValidation(object):
|
||||
|
||||
@property
|
||||
def provider(self) -> str:
|
||||
"""a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at `https://ngrok.com/docs/cloud-edge/modules/webhook <https://ngrok.com/docs/cloud-edge/modules/webhook>`_"""
|
||||
"""a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at `https://ngrok.com/docs/cloud-edge/modules/webhook-verification <https://ngrok.com/docs/cloud-edge/modules/webhook-verification>`_"""
|
||||
return self._props["provider"]
|
||||
|
||||
@property
|
||||
@@ -2690,6 +2921,133 @@ class EndpointWebsocketTCPConverter(object):
|
||||
return self._props["enabled"]
|
||||
|
||||
|
||||
class EndpointUserAgentFilter(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<EndpointUserAgentFilter {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<EndpointUserAgentFilter {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def enabled(self) -> bool:
|
||||
return self._props["enabled"]
|
||||
|
||||
@property
|
||||
def allow(self) -> Sequence[str]:
|
||||
return self._props["allow"]
|
||||
|
||||
@property
|
||||
def deny(self) -> Sequence[str]:
|
||||
return self._props["deny"]
|
||||
|
||||
|
||||
class EndpointPolicy(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["inbound"] = (
|
||||
[EndpointRule(client, x) for x in props["inbound"]]
|
||||
if props.get("inbound") is not None
|
||||
else []
|
||||
)
|
||||
self._props["outbound"] = (
|
||||
[EndpointRule(client, x) for x in props["outbound"]]
|
||||
if props.get("outbound") is not None
|
||||
else []
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<EndpointPolicy {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<EndpointPolicy {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def enabled(self) -> bool:
|
||||
"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
|
||||
return self._props["enabled"]
|
||||
|
||||
@property
|
||||
def inbound(self) -> Sequence[EndpointRule]:
|
||||
"""the inbound rules of the traffic policy."""
|
||||
return self._props["inbound"]
|
||||
|
||||
@property
|
||||
def outbound(self) -> Sequence[EndpointRule]:
|
||||
"""the outbound rules on the traffic policy."""
|
||||
return self._props["outbound"]
|
||||
|
||||
|
||||
class EndpointRule(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["actions"] = (
|
||||
[EndpointAction(client, x) for x in props["actions"]]
|
||||
if props.get("actions") is not None
|
||||
else []
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<EndpointRule {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<EndpointRule {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def expressions(self) -> Sequence[str]:
|
||||
"""cel expressions that filter traffic the policy rule applies to."""
|
||||
return self._props["expressions"]
|
||||
|
||||
@property
|
||||
def actions(self) -> Sequence[EndpointAction]:
|
||||
"""the set of actions on a policy rule."""
|
||||
return self._props["actions"]
|
||||
|
||||
@property
|
||||
def name(self) -> str:
|
||||
"""the name of the rule that is part of the traffic policy."""
|
||||
return self._props["name"]
|
||||
|
||||
|
||||
class EndpointAction(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<EndpointAction {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<EndpointAction {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def type(self) -> str:
|
||||
"""the type of action on the policy rule."""
|
||||
return self._props["type"]
|
||||
|
||||
@property
|
||||
def config(self) -> object:
|
||||
"""the configuration for the action on the policy rule."""
|
||||
return self._props["config"]
|
||||
|
||||
|
||||
class HTTPSEdgeRoute(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
@@ -2749,6 +3107,16 @@ class HTTPSEdgeRoute(object):
|
||||
if props.get("websocket_tcp_converter") is not None
|
||||
else None
|
||||
)
|
||||
self._props["user_agent_filter"] = (
|
||||
EndpointUserAgentFilter(client, props["user_agent_filter"])
|
||||
if props.get("user_agent_filter") is not None
|
||||
else None
|
||||
)
|
||||
self._props["policy"] = (
|
||||
EndpointPolicy(client, props["policy"])
|
||||
if props.get("policy") is not None
|
||||
else None
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
@@ -2776,6 +3144,8 @@ class HTTPSEdgeRoute(object):
|
||||
saml: EndpointSAMLMutate = None,
|
||||
oidc: EndpointOIDC = None,
|
||||
websocket_tcp_converter: EndpointWebsocketTCPConverter = None,
|
||||
user_agent_filter: EndpointUserAgentFilter = None,
|
||||
policy: EndpointPolicy = None,
|
||||
):
|
||||
self._client.edges.https_routes.update(
|
||||
edge_id=self.edge_id,
|
||||
@@ -2795,6 +3165,8 @@ class HTTPSEdgeRoute(object):
|
||||
saml=saml,
|
||||
oidc=oidc,
|
||||
websocket_tcp_converter=websocket_tcp_converter,
|
||||
user_agent_filter=user_agent_filter,
|
||||
policy=policy,
|
||||
)
|
||||
|
||||
def delete(
|
||||
@@ -2900,6 +3272,15 @@ class HTTPSEdgeRoute(object):
|
||||
"""websocket to tcp adapter configuration or ``null``"""
|
||||
return self._props["websocket_tcp_converter"]
|
||||
|
||||
@property
|
||||
def user_agent_filter(self) -> EndpointUserAgentFilter:
|
||||
return self._props["user_agent_filter"]
|
||||
|
||||
@property
|
||||
def policy(self) -> EndpointPolicy:
|
||||
"""the traffic policy associated with this edge or null"""
|
||||
return self._props["policy"]
|
||||
|
||||
|
||||
class HTTPSEdgeList(object):
|
||||
def __init__(self, client, props):
|
||||
@@ -3089,6 +3470,11 @@ class TCPEdge(object):
|
||||
if props.get("ip_restriction") is not None
|
||||
else None
|
||||
)
|
||||
self._props["policy"] = (
|
||||
EndpointPolicy(client, props["policy"])
|
||||
if props.get("policy") is not None
|
||||
else None
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
@@ -3106,6 +3492,7 @@ class TCPEdge(object):
|
||||
hostports: Sequence[str] = None,
|
||||
backend: EndpointBackendMutate = None,
|
||||
ip_restriction: EndpointIPPolicyMutate = None,
|
||||
policy: EndpointPolicy = None,
|
||||
):
|
||||
self._client.edges.tcp.update(
|
||||
id=self.id,
|
||||
@@ -3114,6 +3501,7 @@ class TCPEdge(object):
|
||||
hostports=hostports,
|
||||
backend=backend,
|
||||
ip_restriction=ip_restriction,
|
||||
policy=policy,
|
||||
)
|
||||
|
||||
def delete(
|
||||
@@ -3162,6 +3550,11 @@ class TCPEdge(object):
|
||||
def ip_restriction(self) -> EndpointIPPolicy:
|
||||
return self._props["ip_restriction"]
|
||||
|
||||
@property
|
||||
def policy(self) -> EndpointPolicy:
|
||||
"""the traffic policy associated with this edge or null"""
|
||||
return self._props["policy"]
|
||||
|
||||
|
||||
class TLSEdgeList(object):
|
||||
def __init__(self, client, props):
|
||||
@@ -3225,6 +3618,11 @@ class TLSEdge(object):
|
||||
if props.get("tls_termination") is not None
|
||||
else None
|
||||
)
|
||||
self._props["policy"] = (
|
||||
EndpointPolicy(client, props["policy"])
|
||||
if props.get("policy") is not None
|
||||
else None
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
@@ -3244,6 +3642,7 @@ class TLSEdge(object):
|
||||
ip_restriction: EndpointIPPolicyMutate = None,
|
||||
mutual_tls: EndpointMutualTLSMutate = None,
|
||||
tls_termination: EndpointTLSTermination = None,
|
||||
policy: EndpointPolicy = None,
|
||||
):
|
||||
self._client.edges.tls.update(
|
||||
id=self.id,
|
||||
@@ -3254,6 +3653,7 @@ class TLSEdge(object):
|
||||
ip_restriction=ip_restriction,
|
||||
mutual_tls=mutual_tls,
|
||||
tls_termination=tls_termination,
|
||||
policy=policy,
|
||||
)
|
||||
|
||||
def delete(
|
||||
@@ -3310,6 +3710,11 @@ class TLSEdge(object):
|
||||
def tls_termination(self) -> EndpointTLSTermination:
|
||||
return self._props["tls_termination"]
|
||||
|
||||
@property
|
||||
def policy(self) -> EndpointPolicy:
|
||||
"""the traffic policy associated with this edge or null"""
|
||||
return self._props["policy"]
|
||||
|
||||
|
||||
class Endpoint(object):
|
||||
def __init__(self, client, props):
|
||||
@@ -4459,12 +4864,12 @@ class ReservedDomain(object):
|
||||
|
||||
@property
|
||||
def region(self) -> str:
|
||||
"""reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)"""
|
||||
"""deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)"""
|
||||
return self._props["region"]
|
||||
|
||||
@property
|
||||
def cname_target(self) -> str:
|
||||
"""DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io"""
|
||||
"""DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of an ngrok owned domain (e.g. *.ngrok.app)"""
|
||||
return self._props["cname_target"]
|
||||
|
||||
@property
|
||||
|
||||
+508
-1
@@ -742,6 +742,126 @@ class HTTPResponseBackendsClient(object):
|
||||
return HTTPResponseBackend(self._client, result)
|
||||
|
||||
|
||||
class StaticBackendsClient(object):
|
||||
"""A static backend sends traffic to a TCP address (hostname and port) that
|
||||
is reachable on the public internet."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def create(
|
||||
self,
|
||||
description: str = "",
|
||||
metadata: str = "",
|
||||
address: str = "",
|
||||
tls: StaticBackendTLS = None,
|
||||
) -> StaticBackend:
|
||||
"""Create a new static backend
|
||||
|
||||
:param description: human-readable description of this backend. Optional
|
||||
:param metadata: arbitrary user-defined machine-readable data of this backend. Optional
|
||||
:param address: the address to forward to
|
||||
:param tls: tls configuration to use
|
||||
|
||||
https://ngrok.com/docs/api#api-static-backends-create
|
||||
"""
|
||||
path = "/backends/static"
|
||||
body_arg = dict(
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
address=address,
|
||||
tls=extract_props(tls),
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return StaticBackend(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete a static backend by ID.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-static-backends-delete
|
||||
"""
|
||||
path = "/backends/static/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> StaticBackend:
|
||||
"""Get detailed information about a static backend by ID
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-static-backends-get
|
||||
"""
|
||||
path = "/backends/static/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return StaticBackend(self._client, result)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
) -> StaticBackendList:
|
||||
"""List all static backends on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
|
||||
https://ngrok.com/docs/api#api-static-backends-list
|
||||
"""
|
||||
path = "/backends/static"
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return StaticBackendList(self._client, result)
|
||||
|
||||
def update(
|
||||
self,
|
||||
id: str,
|
||||
description: str = None,
|
||||
metadata: str = None,
|
||||
address: str = "",
|
||||
tls: StaticBackendTLS = None,
|
||||
) -> StaticBackend:
|
||||
"""Update static backend by ID
|
||||
|
||||
:param id:
|
||||
:param description: human-readable description of this backend. Optional
|
||||
:param metadata: arbitrary user-defined machine-readable data of this backend. Optional
|
||||
:param address: the address to forward to
|
||||
:param tls: tls configuration to use
|
||||
|
||||
https://ngrok.com/docs/api#api-static-backends-update
|
||||
"""
|
||||
path = "/backends/static/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = dict(
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
address=address,
|
||||
tls=extract_props(tls),
|
||||
)
|
||||
result = self._client.http_client.patch(path, body_arg)
|
||||
return StaticBackend(self._client, result)
|
||||
|
||||
|
||||
class TunnelGroupBackendsClient(object):
|
||||
"""A Tunnel Group Backend balances traffic among all online tunnels that match
|
||||
a label selector."""
|
||||
@@ -972,6 +1092,111 @@ class WeightedBackendsClient(object):
|
||||
return WeightedBackend(self._client, result)
|
||||
|
||||
|
||||
class BotUsersClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def create(
|
||||
self,
|
||||
name: str = "",
|
||||
active: bool = None,
|
||||
) -> BotUser:
|
||||
"""Create a new bot user
|
||||
|
||||
:param name: human-readable name used to identify the bot
|
||||
:param active: whether or not the bot is active
|
||||
|
||||
https://ngrok.com/docs/api#api-bot-users-create
|
||||
"""
|
||||
path = "/bot_users"
|
||||
body_arg = dict(
|
||||
name=name,
|
||||
active=active,
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return BotUser(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete a bot user by ID
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-bot-users-delete
|
||||
"""
|
||||
path = "/bot_users/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> BotUser:
|
||||
"""Get the details of a Bot User by ID.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-bot-users-get
|
||||
"""
|
||||
path = "/bot_users/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return BotUser(self._client, result)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
) -> BotUserList:
|
||||
"""List all bot users in this account.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
|
||||
https://ngrok.com/docs/api#api-bot-users-list
|
||||
"""
|
||||
path = "/bot_users"
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return BotUserList(self._client, result)
|
||||
|
||||
def update(
|
||||
self,
|
||||
id: str,
|
||||
name: str = None,
|
||||
active: bool = None,
|
||||
) -> BotUser:
|
||||
"""Update attributes of a bot user by ID.
|
||||
|
||||
:param id:
|
||||
:param name: human-readable name used to identify the bot
|
||||
:param active: whether or not the bot is active
|
||||
|
||||
https://ngrok.com/docs/api#api-bot-users-update
|
||||
"""
|
||||
path = "/bot_users/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = dict(
|
||||
name=name,
|
||||
active=active,
|
||||
)
|
||||
result = self._client.http_client.patch(path, body_arg)
|
||||
return BotUser(self._client, result)
|
||||
|
||||
|
||||
class CertificateAuthoritiesClient(object):
|
||||
"""Certificate Authorities are x509 certificates that are used to sign other
|
||||
x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
||||
@@ -1227,6 +1452,8 @@ class EdgesHTTPSRoutesClient(object):
|
||||
saml: EndpointSAMLMutate = None,
|
||||
oidc: EndpointOIDC = None,
|
||||
websocket_tcp_converter: EndpointWebsocketTCPConverter = None,
|
||||
user_agent_filter: EndpointUserAgentFilter = None,
|
||||
policy: EndpointPolicy = None,
|
||||
) -> HTTPSEdgeRoute:
|
||||
"""Create an HTTPS Edge Route
|
||||
|
||||
@@ -1246,6 +1473,8 @@ class EdgesHTTPSRoutesClient(object):
|
||||
:param saml: saml module configuration or ``null``
|
||||
:param oidc: oidc module configuration or ``null``
|
||||
:param websocket_tcp_converter: websocket to tcp adapter configuration or ``null``
|
||||
:param user_agent_filter:
|
||||
:param policy: the traffic policy associated with this edge or null
|
||||
|
||||
https://ngrok.com/docs/api#api-edges-https-routes-create
|
||||
"""
|
||||
@@ -1269,6 +1498,8 @@ class EdgesHTTPSRoutesClient(object):
|
||||
saml=extract_props(saml),
|
||||
oidc=extract_props(oidc),
|
||||
websocket_tcp_converter=extract_props(websocket_tcp_converter),
|
||||
user_agent_filter=extract_props(user_agent_filter),
|
||||
policy=extract_props(policy),
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return HTTPSEdgeRoute(self._client, result)
|
||||
@@ -1313,6 +1544,8 @@ class EdgesHTTPSRoutesClient(object):
|
||||
saml: EndpointSAMLMutate = None,
|
||||
oidc: EndpointOIDC = None,
|
||||
websocket_tcp_converter: EndpointWebsocketTCPConverter = None,
|
||||
user_agent_filter: EndpointUserAgentFilter = None,
|
||||
policy: EndpointPolicy = None,
|
||||
) -> HTTPSEdgeRoute:
|
||||
"""Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
|
||||
|
||||
@@ -1333,6 +1566,8 @@ class EdgesHTTPSRoutesClient(object):
|
||||
:param saml: saml module configuration or ``null``
|
||||
:param oidc: oidc module configuration or ``null``
|
||||
:param websocket_tcp_converter: websocket to tcp adapter configuration or ``null``
|
||||
:param user_agent_filter:
|
||||
:param policy: the traffic policy associated with this edge or null
|
||||
|
||||
https://ngrok.com/docs/api#api-edges-https-routes-update
|
||||
"""
|
||||
@@ -1357,6 +1592,8 @@ class EdgesHTTPSRoutesClient(object):
|
||||
saml=extract_props(saml),
|
||||
oidc=extract_props(oidc),
|
||||
websocket_tcp_converter=extract_props(websocket_tcp_converter),
|
||||
user_agent_filter=extract_props(user_agent_filter),
|
||||
policy=extract_props(policy),
|
||||
)
|
||||
result = self._client.http_client.patch(path, body_arg)
|
||||
return HTTPSEdgeRoute(self._client, result)
|
||||
@@ -2384,6 +2621,144 @@ class EdgeRouteWebsocketTCPConverterModuleClient(object):
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
|
||||
class EdgeRouteUserAgentFilterModuleClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def replace(
|
||||
self,
|
||||
edge_id: str,
|
||||
id: str,
|
||||
module: EndpointUserAgentFilter = None,
|
||||
) -> EndpointUserAgentFilter:
|
||||
"""
|
||||
|
||||
:param edge_id:
|
||||
:param id:
|
||||
:param module:
|
||||
|
||||
https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-replace
|
||||
"""
|
||||
path = "/edges/https/{edge_id}/routes/{id}/user_agent_filter"
|
||||
path = path.format(
|
||||
edge_id=edge_id,
|
||||
id=id,
|
||||
)
|
||||
body_arg = extract_props(module)
|
||||
result = self._client.http_client.put(path, body_arg)
|
||||
return EndpointUserAgentFilter(self._client, result)
|
||||
|
||||
def get(
|
||||
self,
|
||||
edge_id: str,
|
||||
id: str,
|
||||
) -> EndpointUserAgentFilter:
|
||||
"""
|
||||
|
||||
:param edge_id: unique identifier of this edge
|
||||
:param id: unique identifier of this edge route
|
||||
|
||||
https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-get
|
||||
"""
|
||||
path = "/edges/https/{edge_id}/routes/{id}/user_agent_filter"
|
||||
path = path.format(
|
||||
edge_id=edge_id,
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return EndpointUserAgentFilter(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
edge_id: str,
|
||||
id: str,
|
||||
):
|
||||
"""
|
||||
|
||||
:param edge_id: unique identifier of this edge
|
||||
:param id: unique identifier of this edge route
|
||||
|
||||
https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-delete
|
||||
"""
|
||||
path = "/edges/https/{edge_id}/routes/{id}/user_agent_filter"
|
||||
path = path.format(
|
||||
edge_id=edge_id,
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
|
||||
class EdgeRoutePolicyModuleClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def replace(
|
||||
self,
|
||||
edge_id: str,
|
||||
id: str,
|
||||
module: EndpointPolicy = None,
|
||||
) -> EndpointPolicy:
|
||||
"""
|
||||
|
||||
:param edge_id:
|
||||
:param id:
|
||||
:param module:
|
||||
|
||||
https://ngrok.com/docs/api#api-edge-route-policy-module-replace
|
||||
"""
|
||||
path = "/edges/https/{edge_id}/routes/{id}/policy"
|
||||
path = path.format(
|
||||
edge_id=edge_id,
|
||||
id=id,
|
||||
)
|
||||
body_arg = extract_props(module)
|
||||
result = self._client.http_client.put(path, body_arg)
|
||||
return EndpointPolicy(self._client, result)
|
||||
|
||||
def get(
|
||||
self,
|
||||
edge_id: str,
|
||||
id: str,
|
||||
) -> EndpointPolicy:
|
||||
"""
|
||||
|
||||
:param edge_id: unique identifier of this edge
|
||||
:param id: unique identifier of this edge route
|
||||
|
||||
https://ngrok.com/docs/api#api-edge-route-policy-module-get
|
||||
"""
|
||||
path = "/edges/https/{edge_id}/routes/{id}/policy"
|
||||
path = path.format(
|
||||
edge_id=edge_id,
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return EndpointPolicy(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
edge_id: str,
|
||||
id: str,
|
||||
):
|
||||
"""
|
||||
|
||||
:param edge_id: unique identifier of this edge
|
||||
:param id: unique identifier of this edge route
|
||||
|
||||
https://ngrok.com/docs/api#api-edge-route-policy-module-delete
|
||||
"""
|
||||
path = "/edges/https/{edge_id}/routes/{id}/policy"
|
||||
path = path.format(
|
||||
edge_id=edge_id,
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
|
||||
class EdgesTCPClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
@@ -2395,6 +2770,7 @@ class EdgesTCPClient(object):
|
||||
hostports: Sequence[str] = None,
|
||||
backend: EndpointBackendMutate = None,
|
||||
ip_restriction: EndpointIPPolicyMutate = None,
|
||||
policy: EndpointPolicy = None,
|
||||
) -> TCPEdge:
|
||||
"""Create a TCP Edge
|
||||
|
||||
@@ -2403,6 +2779,7 @@ class EdgesTCPClient(object):
|
||||
:param hostports: hostports served by this edge
|
||||
:param backend: edge modules
|
||||
:param ip_restriction:
|
||||
:param policy: the traffic policy associated with this edge or null
|
||||
|
||||
https://ngrok.com/docs/api#api-edges-tcp-create
|
||||
"""
|
||||
@@ -2413,6 +2790,7 @@ class EdgesTCPClient(object):
|
||||
hostports=hostports,
|
||||
backend=extract_props(backend),
|
||||
ip_restriction=extract_props(ip_restriction),
|
||||
policy=extract_props(policy),
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return TCPEdge(self._client, result)
|
||||
@@ -2463,6 +2841,7 @@ class EdgesTCPClient(object):
|
||||
hostports: Sequence[str] = None,
|
||||
backend: EndpointBackendMutate = None,
|
||||
ip_restriction: EndpointIPPolicyMutate = None,
|
||||
policy: EndpointPolicy = None,
|
||||
) -> TCPEdge:
|
||||
"""Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
|
||||
|
||||
@@ -2472,6 +2851,7 @@ class EdgesTCPClient(object):
|
||||
:param hostports: hostports served by this edge
|
||||
:param backend: edge modules
|
||||
:param ip_restriction:
|
||||
:param policy: the traffic policy associated with this edge or null
|
||||
|
||||
https://ngrok.com/docs/api#api-edges-tcp-update
|
||||
"""
|
||||
@@ -2485,6 +2865,7 @@ class EdgesTCPClient(object):
|
||||
hostports=hostports,
|
||||
backend=extract_props(backend),
|
||||
ip_restriction=extract_props(ip_restriction),
|
||||
policy=extract_props(policy),
|
||||
)
|
||||
result = self._client.http_client.patch(path, body_arg)
|
||||
return TCPEdge(self._client, result)
|
||||
@@ -2627,6 +3008,66 @@ class TCPEdgeIPRestrictionModuleClient(object):
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
|
||||
class TCPEdgePolicyModuleClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def replace(
|
||||
self,
|
||||
id: str,
|
||||
module: EndpointPolicy = None,
|
||||
) -> EndpointPolicy:
|
||||
"""
|
||||
|
||||
:param id:
|
||||
:param module:
|
||||
|
||||
https://ngrok.com/docs/api#api-tcp-edge-policy-module-replace
|
||||
"""
|
||||
path = "/edges/tcp/{id}/policy"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = extract_props(module)
|
||||
result = self._client.http_client.put(path, body_arg)
|
||||
return EndpointPolicy(self._client, result)
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> EndpointPolicy:
|
||||
"""
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-tcp-edge-policy-module-get
|
||||
"""
|
||||
path = "/edges/tcp/{id}/policy"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return EndpointPolicy(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-tcp-edge-policy-module-delete
|
||||
"""
|
||||
path = "/edges/tcp/{id}/policy"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
|
||||
class EdgesTLSClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
@@ -2640,6 +3081,7 @@ class EdgesTLSClient(object):
|
||||
ip_restriction: EndpointIPPolicyMutate = None,
|
||||
mutual_tls: EndpointMutualTLSMutate = None,
|
||||
tls_termination: EndpointTLSTermination = None,
|
||||
policy: EndpointPolicy = None,
|
||||
) -> TLSEdge:
|
||||
"""Create a TLS Edge
|
||||
|
||||
@@ -2650,6 +3092,7 @@ class EdgesTLSClient(object):
|
||||
:param ip_restriction:
|
||||
:param mutual_tls:
|
||||
:param tls_termination:
|
||||
:param policy: the traffic policy associated with this edge or null
|
||||
|
||||
https://ngrok.com/docs/api#api-edges-tls-create
|
||||
"""
|
||||
@@ -2662,6 +3105,7 @@ class EdgesTLSClient(object):
|
||||
ip_restriction=extract_props(ip_restriction),
|
||||
mutual_tls=extract_props(mutual_tls),
|
||||
tls_termination=extract_props(tls_termination),
|
||||
policy=extract_props(policy),
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return TLSEdge(self._client, result)
|
||||
@@ -2714,6 +3158,7 @@ class EdgesTLSClient(object):
|
||||
ip_restriction: EndpointIPPolicyMutate = None,
|
||||
mutual_tls: EndpointMutualTLSMutate = None,
|
||||
tls_termination: EndpointTLSTermination = None,
|
||||
policy: EndpointPolicy = None,
|
||||
) -> TLSEdge:
|
||||
"""Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
|
||||
|
||||
@@ -2725,6 +3170,7 @@ class EdgesTLSClient(object):
|
||||
:param ip_restriction:
|
||||
:param mutual_tls:
|
||||
:param tls_termination:
|
||||
:param policy: the traffic policy associated with this edge or null
|
||||
|
||||
https://ngrok.com/docs/api#api-edges-tls-update
|
||||
"""
|
||||
@@ -2740,6 +3186,7 @@ class EdgesTLSClient(object):
|
||||
ip_restriction=extract_props(ip_restriction),
|
||||
mutual_tls=extract_props(mutual_tls),
|
||||
tls_termination=extract_props(tls_termination),
|
||||
policy=extract_props(policy),
|
||||
)
|
||||
result = self._client.http_client.patch(path, body_arg)
|
||||
return TLSEdge(self._client, result)
|
||||
@@ -3002,6 +3449,66 @@ class TLSEdgeTLSTerminationModuleClient(object):
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
|
||||
class TLSEdgePolicyModuleClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def replace(
|
||||
self,
|
||||
id: str,
|
||||
module: EndpointPolicy = None,
|
||||
) -> EndpointPolicy:
|
||||
"""
|
||||
|
||||
:param id:
|
||||
:param module:
|
||||
|
||||
https://ngrok.com/docs/api#api-tls-edge-policy-module-replace
|
||||
"""
|
||||
path = "/edges/tls/{id}/policy"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = extract_props(module)
|
||||
result = self._client.http_client.put(path, body_arg)
|
||||
return EndpointPolicy(self._client, result)
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> EndpointPolicy:
|
||||
"""
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-tls-edge-policy-module-get
|
||||
"""
|
||||
path = "/edges/tls/{id}/policy"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return EndpointPolicy(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-tls-edge-policy-module-delete
|
||||
"""
|
||||
path = "/edges/tls/{id}/policy"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
|
||||
class EndpointsClient(object):
|
||||
"""Endpoints provides an API for querying the endpoint objects
|
||||
which define what tunnel or edge is used to serve a hostport.
|
||||
@@ -3880,7 +4387,7 @@ class ReservedDomainsClient(object):
|
||||
"""Create a new reserved domain.
|
||||
|
||||
:param domain: hostname of the reserved domain
|
||||
:param region: reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
|
||||
:param region: deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)
|
||||
:param description: human-readable description of what this reserved domain will be used for
|
||||
:param metadata: arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
|
||||
:param certificate_id: ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
|
||||
|
||||
@@ -13,7 +13,7 @@ def read_file(filename):
|
||||
|
||||
setup(
|
||||
name="ngrok-api",
|
||||
version="0.10.0",
|
||||
version="0.11.0",
|
||||
description="ngrok HTTP API client library",
|
||||
long_description=read_file("README.md"),
|
||||
long_description_content_type="text/markdown",
|
||||
|
||||
Reference in New Issue
Block a user