diff --git a/.gitignore b/.gitignore index 08951f1..fe5708d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +# Code generated for API Clients. DO NOT EDIT. + doc/build .pyc .swp diff --git a/.tox/dist/ngrok-api-0.0.0.zip b/.tox/dist/ngrok-api-0.0.0.zip index 13be2b0..aa08564 100644 Binary files a/.tox/dist/ngrok-api-0.0.0.zip and b/.tox/dist/ngrok-api-0.0.0.zip differ diff --git a/.tox/log/GLOB-0.log b/.tox/log/GLOB-0.log index 5a03432..c0ef3af 100644 --- a/.tox/log/GLOB-0.log +++ b/.tox/log/GLOB-0.log @@ -1,6 +1,6 @@ action: GLOB, msg: packaging -cwd: /var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python -cmd: /var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir /var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python/.tox/dist +cwd: /var/lib/buildkite-agent-2/builds/ip-172-31-40-132-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python +cmd: /var/lib/buildkite-agent-2/builds/ip-172-31-40-132-us-west-2-compute-internal-2-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 @@ -35,30 +35,29 @@ copying ngrok_api.egg-info/requires.txt -> ngrok-api-0.0.0/ngrok_api.egg-info copying ngrok_api.egg-info/top_level.txt -> ngrok-api-0.0.0/ngrok_api.egg-info copying tests/test_ngrok.py -> ngrok-api-0.0.0/tests Writing ngrok-api-0.0.0/setup.cfg -creating /var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python/.tox/dist -creating '/var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python/.tox/dist/ngrok-api-0.0.0.zip' and adding 'ngrok-api-0.0.0' to it +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/tests' -adding 'ngrok-api-0.0.0/PKG-INFO' adding 'ngrok-api-0.0.0/setup.py' -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/PKG-INFO' +adding 'ngrok-api-0.0.0/pyproject.toml' adding 'ngrok-api-0.0.0/setup.cfg' +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/services.py' +adding 'ngrok-api-0.0.0/ngrok/iterator.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/error.py' adding 'ngrok-api-0.0.0/ngrok/__init__.py' adding 'ngrok-api-0.0.0/ngrok/client.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/iterator.py' -adding 'ngrok-api-0.0.0/ngrok/services.py' adding 'ngrok-api-0.0.0/ngrok_api.egg-info/SOURCES.txt' +adding 'ngrok-api-0.0.0/ngrok_api.egg-info/dependency_links.txt' adding 'ngrok-api-0.0.0/ngrok_api.egg-info/requires.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/dependency_links.txt' -adding 'ngrok-api-0.0.0/tests/test_ngrok.py' removing 'ngrok-api-0.0.0' (and everything under it) diff --git a/README.md b/README.md index 582f828..a783645 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # ngrok API client library for Python This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it diff --git a/doc/Makefile b/doc/Makefile index 18e0af5..3f18cc2 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,3 +1,5 @@ +# Code generated for API Clients. DO NOT EDIT. + # Minimal makefile for Sphinx documentation # diff --git a/doc/make.bat b/doc/make.bat index 6247f7e..074a495 100644 --- a/doc/make.bat +++ b/doc/make.bat @@ -1,35 +1,37 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd +REM Code generated for API Clients. DO NOT EDIT. + +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/doc/source/abuse_reports.rst b/doc/source/abuse_reports.rst index 7791dd6..1d01296 100644 --- a/doc/source/abuse_reports.rst +++ b/doc/source/abuse_reports.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Abuse Reports ===================================== diff --git a/doc/source/agent_ingresses.rst b/doc/source/agent_ingresses.rst index b6cee12..982a6b4 100644 --- a/doc/source/agent_ingresses.rst +++ b/doc/source/agent_ingresses.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Agent Ingresses ===================================== diff --git a/doc/source/api_keys.rst b/doc/source/api_keys.rst index 69593f6..3938dc8 100644 --- a/doc/source/api_keys.rst +++ b/doc/source/api_keys.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + API Keys ===================================== diff --git a/doc/source/application_sessions.rst b/doc/source/application_sessions.rst index fd3ac2d..2ed6b4d 100644 --- a/doc/source/application_sessions.rst +++ b/doc/source/application_sessions.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Application Sessions ===================================== diff --git a/doc/source/application_users.rst b/doc/source/application_users.rst index 7aa4ca6..19f801f 100644 --- a/doc/source/application_users.rst +++ b/doc/source/application_users.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Application Users ===================================== diff --git a/doc/source/certificate_authorities.rst b/doc/source/certificate_authorities.rst index 441b9e4..55ae4ee 100644 --- a/doc/source/certificate_authorities.rst +++ b/doc/source/certificate_authorities.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Certificate Authorities ===================================== diff --git a/doc/source/client.rst b/doc/source/client.rst index e10ab95..18c30c5 100644 --- a/doc/source/client.rst +++ b/doc/source/client.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Client ===================================== @@ -15,7 +18,7 @@ Client object: # list all ip policies for policy in client.ip_policies.list(): print(policy) - + # create an ngrok agent authtoken cred = client.credentials.create() print(cred) diff --git a/doc/source/conf.py b/doc/source/conf.py index f6d5852..d096775 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,3 +1,5 @@ +# Code generated for API Clients. DO NOT EDIT. + # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full diff --git a/doc/source/credentials.rst b/doc/source/credentials.rst index 4af64a3..a2bb3f4 100644 --- a/doc/source/credentials.rst +++ b/doc/source/credentials.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Tunnel Credentials ===================================== diff --git a/doc/source/datatypes.rst b/doc/source/datatypes.rst index 7db4f9d..1b4d803 100644 --- a/doc/source/datatypes.rst +++ b/doc/source/datatypes.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Datatypes ===================================== diff --git a/doc/source/edge_route_backend_module.rst b/doc/source/edge_route_backend_module.rst index 7e3dbe3..59ac3be 100644 --- a/doc/source/edge_route_backend_module.rst +++ b/doc/source/edge_route_backend_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Backend Module ===================================== diff --git a/doc/source/edge_route_circuit_breaker_module.rst b/doc/source/edge_route_circuit_breaker_module.rst index fea725c..a94dc50 100644 --- a/doc/source/edge_route_circuit_breaker_module.rst +++ b/doc/source/edge_route_circuit_breaker_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Circuit Breaker Module ===================================== diff --git a/doc/source/edge_route_compression_module.rst b/doc/source/edge_route_compression_module.rst index 4bbd06a..9e36972 100644 --- a/doc/source/edge_route_compression_module.rst +++ b/doc/source/edge_route_compression_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Compression Module ===================================== diff --git a/doc/source/edge_route_ip_restriction_module.rst b/doc/source/edge_route_ip_restriction_module.rst index 243888f..23332bb 100644 --- a/doc/source/edge_route_ip_restriction_module.rst +++ b/doc/source/edge_route_ip_restriction_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route IP Restriction Module ===================================== diff --git a/doc/source/edge_route_o_auth_module.rst b/doc/source/edge_route_o_auth_module.rst index 9e7f81a..3fd3c7b 100644 --- a/doc/source/edge_route_o_auth_module.rst +++ b/doc/source/edge_route_o_auth_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route OAuth Module ===================================== diff --git a/doc/source/edge_route_oidc_module.rst b/doc/source/edge_route_oidc_module.rst index abef39e..1b3997b 100644 --- a/doc/source/edge_route_oidc_module.rst +++ b/doc/source/edge_route_oidc_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route OIDC Module ===================================== diff --git a/doc/source/edge_route_request_headers_module.rst b/doc/source/edge_route_request_headers_module.rst index 5d5e26a..5e28e7e 100644 --- a/doc/source/edge_route_request_headers_module.rst +++ b/doc/source/edge_route_request_headers_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Request Headers Module ===================================== diff --git a/doc/source/edge_route_response_headers_module.rst b/doc/source/edge_route_response_headers_module.rst index 479644b..97156e9 100644 --- a/doc/source/edge_route_response_headers_module.rst +++ b/doc/source/edge_route_response_headers_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Response Headers Module ===================================== diff --git a/doc/source/edge_route_saml_module.rst b/doc/source/edge_route_saml_module.rst index aba3e12..4bd60c6 100644 --- a/doc/source/edge_route_saml_module.rst +++ b/doc/source/edge_route_saml_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route SAML Module ===================================== diff --git a/doc/source/edge_route_webhook_verification_module.rst b/doc/source/edge_route_webhook_verification_module.rst index 0cfc3fa..f42c30e 100644 --- a/doc/source/edge_route_webhook_verification_module.rst +++ b/doc/source/edge_route_webhook_verification_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Webhook Verification Module ===================================== diff --git a/doc/source/edge_route_websocket_tcp_converter_module.rst b/doc/source/edge_route_websocket_tcp_converter_module.rst index 4436c86..a586b27 100644 --- a/doc/source/edge_route_websocket_tcp_converter_module.rst +++ b/doc/source/edge_route_websocket_tcp_converter_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Websocket TCP Converter Module ===================================== diff --git a/doc/source/edges_https.rst b/doc/source/edges_https.rst index c8bbe29..1e09836 100644 --- a/doc/source/edges_https.rst +++ b/doc/source/edges_https.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edges ===================================== diff --git a/doc/source/edges_https_routes.rst b/doc/source/edges_https_routes.rst index afb0ce7..c2ecc23 100644 --- a/doc/source/edges_https_routes.rst +++ b/doc/source/edges_https_routes.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Routes ===================================== diff --git a/doc/source/edges_tcp.rst b/doc/source/edges_tcp.rst index b10e177..4361561 100644 --- a/doc/source/edges_tcp.rst +++ b/doc/source/edges_tcp.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TCP Edges ===================================== diff --git a/doc/source/edges_tls.rst b/doc/source/edges_tls.rst index 4b163d1..cbf751a 100644 --- a/doc/source/edges_tls.rst +++ b/doc/source/edges_tls.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edges ===================================== diff --git a/doc/source/endpoints.rst b/doc/source/endpoints.rst index 227a642..f15e5e4 100644 --- a/doc/source/endpoints.rst +++ b/doc/source/endpoints.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Endpoints ===================================== diff --git a/doc/source/errors.rst b/doc/source/errors.rst index 301a65e..5b03e51 100644 --- a/doc/source/errors.rst +++ b/doc/source/errors.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + .. _errors: Errors diff --git a/doc/source/event_destinations.rst b/doc/source/event_destinations.rst index b05b317..c674b45 100644 --- a/doc/source/event_destinations.rst +++ b/doc/source/event_destinations.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Event Destinations ===================================== diff --git a/doc/source/event_sources.rst b/doc/source/event_sources.rst index f096cc0..82541e8 100644 --- a/doc/source/event_sources.rst +++ b/doc/source/event_sources.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Event Sources ===================================== diff --git a/doc/source/event_subscriptions.rst b/doc/source/event_subscriptions.rst index 89bc463..1fab08b 100644 --- a/doc/source/event_subscriptions.rst +++ b/doc/source/event_subscriptions.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Event Subscriptions ===================================== diff --git a/doc/source/failover_backends.rst b/doc/source/failover_backends.rst index 9f8905c..9437ab7 100644 --- a/doc/source/failover_backends.rst +++ b/doc/source/failover_backends.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Failover Backends ===================================== diff --git a/doc/source/http_response_backends.rst b/doc/source/http_response_backends.rst index 006e269..23e36d3 100644 --- a/doc/source/http_response_backends.rst +++ b/doc/source/http_response_backends.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTP Response Backends ===================================== diff --git a/doc/source/https_edge_mutual_tls_module.rst b/doc/source/https_edge_mutual_tls_module.rst index 96a49a1..b64666d 100644 --- a/doc/source/https_edge_mutual_tls_module.rst +++ b/doc/source/https_edge_mutual_tls_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Mutual TLS Module ===================================== diff --git a/doc/source/https_edge_tls_termination_module.rst b/doc/source/https_edge_tls_termination_module.rst index 48c8b98..8aa2e66 100644 --- a/doc/source/https_edge_tls_termination_module.rst +++ b/doc/source/https_edge_tls_termination_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge TLS Termination Module ===================================== diff --git a/doc/source/index.rst b/doc/source/index.rst index 35697fc..1fce46a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + ngrok-api ######### @@ -125,6 +128,7 @@ API Reference api_keys application_sessions application_users + tunnel_sessions failover_backends http_response_backends tunnel_group_backends @@ -168,5 +172,4 @@ API Reference ssh_host_certificates ssh_user_certificates tls_certificates - tunnel_sessions tunnels diff --git a/doc/source/ip_policies.rst b/doc/source/ip_policies.rst index 1799260..1b3cde8 100644 --- a/doc/source/ip_policies.rst +++ b/doc/source/ip_policies.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + IP Policies ===================================== diff --git a/doc/source/ip_policy_rules.rst b/doc/source/ip_policy_rules.rst index c109f93..52b22a4 100644 --- a/doc/source/ip_policy_rules.rst +++ b/doc/source/ip_policy_rules.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + IP Policy Rules ===================================== diff --git a/doc/source/ip_restrictions.rst b/doc/source/ip_restrictions.rst index 6593c97..5d5f3bc 100644 --- a/doc/source/ip_restrictions.rst +++ b/doc/source/ip_restrictions.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + IP Restrictions ===================================== diff --git a/doc/source/reserved_addrs.rst b/doc/source/reserved_addrs.rst index aaf4f40..e00b300 100644 --- a/doc/source/reserved_addrs.rst +++ b/doc/source/reserved_addrs.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Reserved Addresses ===================================== diff --git a/doc/source/reserved_domains.rst b/doc/source/reserved_domains.rst index c1630b5..86758eb 100644 --- a/doc/source/reserved_domains.rst +++ b/doc/source/reserved_domains.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Reserved Domains ===================================== diff --git a/doc/source/ssh_certificate_authorities.rst b/doc/source/ssh_certificate_authorities.rst index 4bf9cd9..24dbf76 100644 --- a/doc/source/ssh_certificate_authorities.rst +++ b/doc/source/ssh_certificate_authorities.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + SSH Certificate Authorities ===================================== diff --git a/doc/source/ssh_credentials.rst b/doc/source/ssh_credentials.rst index 06044bf..c73991a 100644 --- a/doc/source/ssh_credentials.rst +++ b/doc/source/ssh_credentials.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + SSH Credentials ===================================== diff --git a/doc/source/ssh_host_certificates.rst b/doc/source/ssh_host_certificates.rst index 9e0b6db..e3387c1 100644 --- a/doc/source/ssh_host_certificates.rst +++ b/doc/source/ssh_host_certificates.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + SSH Host Certificates ===================================== diff --git a/doc/source/ssh_user_certificates.rst b/doc/source/ssh_user_certificates.rst index 4cb5fee..e63abae 100644 --- a/doc/source/ssh_user_certificates.rst +++ b/doc/source/ssh_user_certificates.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + SSH User Certificates ===================================== diff --git a/doc/source/tcp_edge_backend_module.rst b/doc/source/tcp_edge_backend_module.rst index 636003c..98b2a5f 100644 --- a/doc/source/tcp_edge_backend_module.rst +++ b/doc/source/tcp_edge_backend_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TCP Edge Backend Module ===================================== diff --git a/doc/source/tcp_edge_ip_restriction_module.rst b/doc/source/tcp_edge_ip_restriction_module.rst index f847cc5..24810b1 100644 --- a/doc/source/tcp_edge_ip_restriction_module.rst +++ b/doc/source/tcp_edge_ip_restriction_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TCP Edge IP Restriction Module ===================================== diff --git a/doc/source/tls_certificates.rst b/doc/source/tls_certificates.rst index a664ecc..eb06183 100644 --- a/doc/source/tls_certificates.rst +++ b/doc/source/tls_certificates.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Certificates ===================================== diff --git a/doc/source/tls_edge_backend_module.rst b/doc/source/tls_edge_backend_module.rst index 1aa9ef6..8abf12f 100644 --- a/doc/source/tls_edge_backend_module.rst +++ b/doc/source/tls_edge_backend_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edge Backend Module ===================================== diff --git a/doc/source/tls_edge_ip_restriction_module.rst b/doc/source/tls_edge_ip_restriction_module.rst index ed49b58..b9d14c9 100644 --- a/doc/source/tls_edge_ip_restriction_module.rst +++ b/doc/source/tls_edge_ip_restriction_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edge IP Restriction Module ===================================== diff --git a/doc/source/tls_edge_mutual_tls_module.rst b/doc/source/tls_edge_mutual_tls_module.rst index bee4644..f8ff76d 100644 --- a/doc/source/tls_edge_mutual_tls_module.rst +++ b/doc/source/tls_edge_mutual_tls_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edge Mutual TLS Module ===================================== diff --git a/doc/source/tls_edge_tls_termination_module.rst b/doc/source/tls_edge_tls_termination_module.rst index 55c4d52..60189de 100644 --- a/doc/source/tls_edge_tls_termination_module.rst +++ b/doc/source/tls_edge_tls_termination_module.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edge TLS Termination Module ===================================== diff --git a/doc/source/tunnel_group_backends.rst b/doc/source/tunnel_group_backends.rst index 0f0acac..6b997cf 100644 --- a/doc/source/tunnel_group_backends.rst +++ b/doc/source/tunnel_group_backends.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Tunnel Group Backends ===================================== diff --git a/doc/source/tunnel_sessions.rst b/doc/source/tunnel_sessions.rst index d03189a..5d5b640 100644 --- a/doc/source/tunnel_sessions.rst +++ b/doc/source/tunnel_sessions.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Tunnel Sessions ===================================== diff --git a/doc/source/tunnels.rst b/doc/source/tunnels.rst index 347285b..e3cad8a 100644 --- a/doc/source/tunnels.rst +++ b/doc/source/tunnels.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Tunnels ===================================== diff --git a/doc/source/weighted_backends.rst b/doc/source/weighted_backends.rst index f9781bd..496f0c8 100644 --- a/doc/source/weighted_backends.rst +++ b/doc/source/weighted_backends.rst @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Weighted Backends ===================================== diff --git a/docs/_modules/index.html b/docs/_modules/index.html index 69bc3de..55c1940 100644 --- a/docs/_modules/index.html +++ b/docs/_modules/index.html @@ -166,6 +166,7 @@
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -209,7 +210,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • diff --git a/docs/_modules/ngrok/client.html b/docs/_modules/ngrok/client.html index 5548197..5af2cb5 100644 --- a/docs/_modules/ngrok/client.html +++ b/docs/_modules/ngrok/client.html @@ -166,6 +166,7 @@
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -209,7 +210,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • @@ -245,7 +245,10 @@

    Source code for ngrok.client

    -from __future__ import annotations
    +# Code generated for API Clients. DO NOT EDIT.
    +
    +
    +from __future__ import annotations
     import collections
     import os
     from .services import *
    @@ -282,6 +285,13 @@
         def application_users(self) -> ApplicationUsersClient:
             return ApplicationUsersClient(self)
     
    +    @property
    +    def tunnel_sessions(self) -> TunnelSessionsClient:
    +        """Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
    +        sessions that are running and connected to the ngrok service. Each tunnel
    +        session can include one or more Tunnels."""
    +        return TunnelSessionsClient(self)
    +
         @property
         def certificate_authorities(self) -> CertificateAuthoritiesClient:
             """Certificate Authorities are x509 certificates that are used to sign other
    @@ -392,13 +402,6 @@
             automated certificate provisioning."""
             return TLSCertificatesClient(self)
     
    -    @property
    -    def tunnel_sessions(self) -> TunnelSessionsClient:
    -        """Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
    -        sessions that are running and connected to the ngrok service. Each tunnel
    -        session can include one or more Tunnels."""
    -        return TunnelSessionsClient(self)
    -
         @property
         def tunnels(self) -> TunnelsClient:
             """Tunnels provide endpoints to access services exposed by a running ngrok
    diff --git a/docs/_modules/ngrok/datatypes.html b/docs/_modules/ngrok/datatypes.html
    index e610739..6d80d1b 100644
    --- a/docs/_modules/ngrok/datatypes.html
    +++ b/docs/_modules/ngrok/datatypes.html
    @@ -166,6 +166,7 @@
     
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -209,7 +210,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • @@ -245,7 +245,10 @@

    Source code for ngrok.datatypes

    -from __future__ import annotations
    +# Code generated for API Clients. DO NOT EDIT.
    +
    +
    +from __future__ import annotations
     from typing import Any, Mapping, Sequence
     from datetime import datetime, timedelta
     from .iterator import PagedIterator
    @@ -969,6 +972,114 @@
             return self._props["url"]
    +
    [docs]class TunnelSession(object): + def __init__(self, client, props): + self._client = client + self._props = props + self._props["credential"] = ( + Ref(client, props["credential"]) + if props.get("credential") is not None + else None + ) + + def __eq__(self, other): + return self._props == other._props + + def __str__(self): + if "id" in self._props: + return "<TunnelSession {} {}>".format(self.id, repr(self._props)) + else: + return "<TunnelSession {}>".format(repr(self._props)) + + @property + def agent_version(self) -> str: + """version of the ngrok agent that started this ngrok tunnel session""" + return self._props["agent_version"] + + @property + def credential(self) -> Ref: + """reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session""" + return self._props["credential"] + + @property + def id(self) -> str: + """unique tunnel session resource identifier""" + return self._props["id"] + + @property + def ip(self) -> str: + """source ip address of the tunnel session""" + return self._props["ip"] + + @property + def metadata(self) -> str: + """arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option""" + return self._props["metadata"] + + @property + def os(self) -> str: + """operating system of the host the ngrok agent is running on""" + return self._props["os"] + + @property + def region(self) -> str: + """the ngrok region identifier in which this tunnel session was started""" + return self._props["region"] + + @property + def started_at(self) -> datetime: + """time when the tunnel session first connected to the ngrok servers""" + return self._props["started_at"] + + @property + def transport(self) -> str: + """the transport protocol used to start the tunnel session. Either ``ngrok/v2`` or ``ssh``""" + return self._props["transport"] + + @property + def uri(self) -> str: + """URI to the API resource of the tunnel session""" + return self._props["uri"]
    + + +
    [docs]class TunnelSessionList(object): + def __init__(self, client, props): + self._client = client + self._props = props + self._props["tunnel_sessions"] = ( + [TunnelSession(client, x) for x in props["tunnel_sessions"]] + if props.get("tunnel_sessions") is not None + else [] + ) + + def __eq__(self, other): + return self._props == other._props + + def __str__(self): + if "id" in self._props: + return "<TunnelSessionList {} {}>".format(self.id, repr(self._props)) + else: + return "<TunnelSessionList {}>".format(repr(self._props)) + + def __iter__(self): + return PagedIterator(self._client, self, "tunnel_sessions") + + @property + def tunnel_sessions(self) -> Sequence[TunnelSession]: + """list of all tunnel sessions on this account""" + return self._props["tunnel_sessions"] + + @property + def uri(self) -> str: + """URI to the API resource of the tunnel session list""" + 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"]
    + +
    [docs]class FailoverBackend(object): def __init__(self, client, props): self._client = client @@ -3586,6 +3697,11 @@ if props.get("cloudwatch_logs") is not None else None ) + self._props["datadog"] = ( + EventTargetDatadog(client, props["datadog"]) + if props.get("datadog") is not None + else None + ) def __eq__(self, other): return self._props == other._props @@ -3609,7 +3725,12 @@ @property def cloudwatch_logs(self) -> EventTargetCloudwatchLogs: """Configuration used to send events to Amazon CloudWatch Logs.""" - return self._props["cloudwatch_logs"]
    + return self._props["cloudwatch_logs"] + + @property + def datadog(self) -> EventTargetDatadog: + """Configuration used to send events to Datadog.""" + return self._props["datadog"]
    [docs]class EventTargetFirehose(object): @@ -3698,6 +3819,41 @@ return self._props["log_group_arn"]
    +
    [docs]class EventTargetDatadog(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 "<EventTargetDatadog {} {}>".format(self.id, repr(self._props)) + else: + return "<EventTargetDatadog {}>".format(repr(self._props)) + + @property + def api_key(self) -> str: + """Datadog API key to use.""" + return self._props["api_key"] + + @property + def ddtags(self) -> str: + """Tags to send with the event.""" + return self._props["ddtags"] + + @property + def service(self) -> str: + """Service name to send with the event.""" + return self._props["service"] + + @property + def ddsite(self) -> str: + """Datadog site to send event to.""" + return self._props["ddsite"]
    + +
    [docs]class AWSAuth(object): def __init__(self, client, props): self._client = client @@ -5155,7 +5311,7 @@ @property def certificate_pem(self) -> str: - """chain of PEM-encoded certificates, leaf first. See `Certificate Bundles </cloud-edge/endpoints#certificate-chains>`_.""" + """chain of PEM-encoded certificates, leaf first. See `Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>`_.""" return self._props["certificate_pem"] @property @@ -5297,114 +5453,6 @@ return self._props["ips"]
    -
    [docs]class TunnelSession(object): - def __init__(self, client, props): - self._client = client - self._props = props - self._props["credential"] = ( - Ref(client, props["credential"]) - if props.get("credential") is not None - else None - ) - - def __eq__(self, other): - return self._props == other._props - - def __str__(self): - if "id" in self._props: - return "<TunnelSession {} {}>".format(self.id, repr(self._props)) - else: - return "<TunnelSession {}>".format(repr(self._props)) - - @property - def agent_version(self) -> str: - """version of the ngrok agent that started this ngrok tunnel session""" - return self._props["agent_version"] - - @property - def credential(self) -> Ref: - """reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session""" - return self._props["credential"] - - @property - def id(self) -> str: - """unique tunnel session resource identifier""" - return self._props["id"] - - @property - def ip(self) -> str: - """source ip address of the tunnel session""" - return self._props["ip"] - - @property - def metadata(self) -> str: - """arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option""" - return self._props["metadata"] - - @property - def os(self) -> str: - """operating system of the host the ngrok agent is running on""" - return self._props["os"] - - @property - def region(self) -> str: - """the ngrok region identifier in which this tunnel session was started""" - return self._props["region"] - - @property - def started_at(self) -> datetime: - """time when the tunnel session first connected to the ngrok servers""" - return self._props["started_at"] - - @property - def transport(self) -> str: - """the transport protocol used to start the tunnel session. Either ``ngrok/v2`` or ``ssh``""" - return self._props["transport"] - - @property - def uri(self) -> str: - """URI to the API resource of the tunnel session""" - return self._props["uri"]
    - - -
    [docs]class TunnelSessionList(object): - def __init__(self, client, props): - self._client = client - self._props = props - self._props["tunnel_sessions"] = ( - [TunnelSession(client, x) for x in props["tunnel_sessions"]] - if props.get("tunnel_sessions") is not None - else [] - ) - - def __eq__(self, other): - return self._props == other._props - - def __str__(self): - if "id" in self._props: - return "<TunnelSessionList {} {}>".format(self.id, repr(self._props)) - else: - return "<TunnelSessionList {}>".format(repr(self._props)) - - def __iter__(self): - return PagedIterator(self._client, self, "tunnel_sessions") - - @property - def tunnel_sessions(self) -> Sequence[TunnelSession]: - """list of all tunnel sessions on this account""" - return self._props["tunnel_sessions"] - - @property - def uri(self) -> str: - """URI to the API resource of the tunnel session list""" - 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"]
    - -
    [docs]class Tunnel(object): def __init__(self, client, props): self._client = client @@ -5451,7 +5499,7 @@ @property def metadata(self) -> str: - """user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel `metadata configuration option </ngrok-agent/config#common-tunnel-configuration-properties>`_ In API version 0, this value was instead pulled from the top-level `metadata configuration option </ngrok-agent/config#metadata>`_.""" + """user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel `metadata configuration option <https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#common-tunnel-configuration-properties>`_ In API version 0, this value was instead pulled from the top-level `metadata configuration option <https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#metadata>`_.""" return self._props["metadata"] @property diff --git a/docs/_modules/ngrok/error.html b/docs/_modules/ngrok/error.html index 297097c..c63d798 100644 --- a/docs/_modules/ngrok/error.html +++ b/docs/_modules/ngrok/error.html @@ -166,6 +166,7 @@
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -209,7 +210,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • @@ -245,7 +245,9 @@

    Source code for ngrok.error

    -from typing import Any, Optional
    +# Code generated for API Clients. DO NOT EDIT.
    +
    +from typing import Any, Optional
     
     
     
    [docs]class Error(Exception): diff --git a/docs/_modules/ngrok/services.html b/docs/_modules/ngrok/services.html index 61584f3..43a4190 100644 --- a/docs/_modules/ngrok/services.html +++ b/docs/_modules/ngrok/services.html @@ -166,6 +166,7 @@
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -209,7 +210,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • @@ -245,7 +245,10 @@

    Source code for ngrok.services

    -from __future__ import annotations
    +# Code generated for API Clients. DO NOT EDIT.
    +
    +
    +from __future__ import annotations
     from collections.abc import Iterator
     from typing import Any, Mapping, Sequence
     from datetime import datetime, timedelta
    @@ -643,6 +646,104 @@
             return ApplicationUserList(self._client, result)
    +
    [docs]class TunnelSessionsClient(object): + """Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel + sessions that are running and connected to the ngrok service. Each tunnel + session can include one or more Tunnels.""" + + def __init__(self, client): + self._client = client + +
    [docs] def list( + self, + before_id: str = None, + limit: str = None, + ) -> TunnelSessionList: + """List all online tunnel sessions running on this account. + + :param before_id: + :param limit: + + https://ngrok.com/docs/api#api-tunnel-sessions-list + """ + path = "/tunnel_sessions" + body_arg = dict( + before_id=before_id, + limit=limit, + ) + result = self._client.http_client.get(path, body_arg) + return TunnelSessionList(self._client, result)
    + +
    [docs] def get( + self, + id: str, + ) -> TunnelSession: + """Get the detailed status of a tunnel session by ID + + :param id: a resource identifier + + https://ngrok.com/docs/api#api-tunnel-sessions-get + """ + path = "/tunnel_sessions/{id}" + path = path.format( + id=id, + ) + body_arg = None + result = self._client.http_client.get(path, body_arg) + return TunnelSession(self._client, result)
    + +
    [docs] def restart( + self, + id: str, + ): + """Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID. + + :param id: a resource identifier + + https://ngrok.com/docs/api#api-tunnel-sessions-restart + """ + path = "/tunnel_sessions/{id}/restart" + path = path.format( + id=id, + ) + body_arg = None + self._client.http_client.post(path, body_arg)
    + +
    [docs] def stop( + self, + id: str, + ): + """Issues a command instructing the ngrok agent that started this tunnel session to exit. + + :param id: a resource identifier + + https://ngrok.com/docs/api#api-tunnel-sessions-stop + """ + path = "/tunnel_sessions/{id}/stop" + path = path.format( + id=id, + ) + body_arg = None + self._client.http_client.post(path, body_arg)
    + +
    [docs] def update( + self, + id: str, + ): + """Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted + + :param id: + + https://ngrok.com/docs/api#api-tunnel-sessions-update + """ + path = "/tunnel_sessions/{id}/update" + path = path.format( + id=id, + ) + body_arg = None + self._client.http_client.post(path, body_arg)
    + +
    [docs]class FailoverBackendsClient(object): """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 @@ -4010,7 +4111,6 @@
    [docs] def create( self, - name: str = "", domain: str = "", region: str = "", description: str = "", @@ -4020,7 +4120,6 @@ ) -> ReservedDomain: """Create a new reserved domain. - :param name: the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io. :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 description: human-readable description of what this reserved domain will be used for @@ -4032,7 +4131,6 @@ """ path = "/reserved_domains" body_arg = dict( - name=name, domain=domain, region=region, description=description, @@ -4676,8 +4774,8 @@ :param description: human-readable description of this TLS certificate. optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. - :param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles </cloud-edge/endpoints#certificate-chains>`_. - :param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys </cloud-edge/endpoints#private-keys>`_. + :param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>`_. + :param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys>`_. https://ngrok.com/docs/api#api-tls-certificates-create """ @@ -4772,104 +4870,6 @@ return TLSCertificate(self._client, result)
    -
    [docs]class TunnelSessionsClient(object): - """Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel - sessions that are running and connected to the ngrok service. Each tunnel - session can include one or more Tunnels.""" - - def __init__(self, client): - self._client = client - -
    [docs] def list( - self, - before_id: str = None, - limit: str = None, - ) -> TunnelSessionList: - """List all online tunnel sessions running on this account. - - :param before_id: - :param limit: - - https://ngrok.com/docs/api#api-tunnel-sessions-list - """ - path = "/tunnel_sessions" - body_arg = dict( - before_id=before_id, - limit=limit, - ) - result = self._client.http_client.get(path, body_arg) - return TunnelSessionList(self._client, result)
    - -
    [docs] def get( - self, - id: str, - ) -> TunnelSession: - """Get the detailed status of a tunnel session by ID - - :param id: a resource identifier - - https://ngrok.com/docs/api#api-tunnel-sessions-get - """ - path = "/tunnel_sessions/{id}" - path = path.format( - id=id, - ) - body_arg = None - result = self._client.http_client.get(path, body_arg) - return TunnelSession(self._client, result)
    - -
    [docs] def restart( - self, - id: str, - ): - """Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID. - - :param id: a resource identifier - - https://ngrok.com/docs/api#api-tunnel-sessions-restart - """ - path = "/tunnel_sessions/{id}/restart" - path = path.format( - id=id, - ) - body_arg = None - self._client.http_client.post(path, body_arg)
    - -
    [docs] def stop( - self, - id: str, - ): - """Issues a command instructing the ngrok agent that started this tunnel session to exit. - - :param id: a resource identifier - - https://ngrok.com/docs/api#api-tunnel-sessions-stop - """ - path = "/tunnel_sessions/{id}/stop" - path = path.format( - id=id, - ) - body_arg = None - self._client.http_client.post(path, body_arg)
    - -
    [docs] def update( - self, - id: str, - ): - """Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted - - :param id: - - https://ngrok.com/docs/api#api-tunnel-sessions-update - """ - path = "/tunnel_sessions/{id}/update" - path = path.format( - id=id, - ) - body_arg = None - self._client.http_client.post(path, body_arg)
    - -
    [docs]class TunnelsClient(object): """Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.""" diff --git a/docs/_sources/abuse_reports.rst.txt b/docs/_sources/abuse_reports.rst.txt index 7791dd6..1d01296 100644 --- a/docs/_sources/abuse_reports.rst.txt +++ b/docs/_sources/abuse_reports.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Abuse Reports ===================================== diff --git a/docs/_sources/agent_ingresses.rst.txt b/docs/_sources/agent_ingresses.rst.txt index b6cee12..982a6b4 100644 --- a/docs/_sources/agent_ingresses.rst.txt +++ b/docs/_sources/agent_ingresses.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Agent Ingresses ===================================== diff --git a/docs/_sources/api_keys.rst.txt b/docs/_sources/api_keys.rst.txt index 69593f6..3938dc8 100644 --- a/docs/_sources/api_keys.rst.txt +++ b/docs/_sources/api_keys.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + API Keys ===================================== diff --git a/docs/_sources/application_sessions.rst.txt b/docs/_sources/application_sessions.rst.txt index fd3ac2d..2ed6b4d 100644 --- a/docs/_sources/application_sessions.rst.txt +++ b/docs/_sources/application_sessions.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Application Sessions ===================================== diff --git a/docs/_sources/application_users.rst.txt b/docs/_sources/application_users.rst.txt index 7aa4ca6..19f801f 100644 --- a/docs/_sources/application_users.rst.txt +++ b/docs/_sources/application_users.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Application Users ===================================== diff --git a/docs/_sources/certificate_authorities.rst.txt b/docs/_sources/certificate_authorities.rst.txt index 441b9e4..55ae4ee 100644 --- a/docs/_sources/certificate_authorities.rst.txt +++ b/docs/_sources/certificate_authorities.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Certificate Authorities ===================================== diff --git a/docs/_sources/client.rst.txt b/docs/_sources/client.rst.txt index e10ab95..18c30c5 100644 --- a/docs/_sources/client.rst.txt +++ b/docs/_sources/client.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Client ===================================== @@ -15,7 +18,7 @@ Client object: # list all ip policies for policy in client.ip_policies.list(): print(policy) - + # create an ngrok agent authtoken cred = client.credentials.create() print(cred) diff --git a/docs/_sources/credentials.rst.txt b/docs/_sources/credentials.rst.txt index 4af64a3..a2bb3f4 100644 --- a/docs/_sources/credentials.rst.txt +++ b/docs/_sources/credentials.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Tunnel Credentials ===================================== diff --git a/docs/_sources/datatypes.rst.txt b/docs/_sources/datatypes.rst.txt index 7db4f9d..1b4d803 100644 --- a/docs/_sources/datatypes.rst.txt +++ b/docs/_sources/datatypes.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Datatypes ===================================== diff --git a/docs/_sources/edge_route_backend_module.rst.txt b/docs/_sources/edge_route_backend_module.rst.txt index 7e3dbe3..59ac3be 100644 --- a/docs/_sources/edge_route_backend_module.rst.txt +++ b/docs/_sources/edge_route_backend_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Backend Module ===================================== diff --git a/docs/_sources/edge_route_circuit_breaker_module.rst.txt b/docs/_sources/edge_route_circuit_breaker_module.rst.txt index fea725c..a94dc50 100644 --- a/docs/_sources/edge_route_circuit_breaker_module.rst.txt +++ b/docs/_sources/edge_route_circuit_breaker_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Circuit Breaker Module ===================================== diff --git a/docs/_sources/edge_route_compression_module.rst.txt b/docs/_sources/edge_route_compression_module.rst.txt index 4bbd06a..9e36972 100644 --- a/docs/_sources/edge_route_compression_module.rst.txt +++ b/docs/_sources/edge_route_compression_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Compression Module ===================================== diff --git a/docs/_sources/edge_route_ip_restriction_module.rst.txt b/docs/_sources/edge_route_ip_restriction_module.rst.txt index 243888f..23332bb 100644 --- a/docs/_sources/edge_route_ip_restriction_module.rst.txt +++ b/docs/_sources/edge_route_ip_restriction_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route IP Restriction Module ===================================== diff --git a/docs/_sources/edge_route_o_auth_module.rst.txt b/docs/_sources/edge_route_o_auth_module.rst.txt index 9e7f81a..3fd3c7b 100644 --- a/docs/_sources/edge_route_o_auth_module.rst.txt +++ b/docs/_sources/edge_route_o_auth_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route OAuth Module ===================================== diff --git a/docs/_sources/edge_route_oidc_module.rst.txt b/docs/_sources/edge_route_oidc_module.rst.txt index abef39e..1b3997b 100644 --- a/docs/_sources/edge_route_oidc_module.rst.txt +++ b/docs/_sources/edge_route_oidc_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route OIDC Module ===================================== diff --git a/docs/_sources/edge_route_request_headers_module.rst.txt b/docs/_sources/edge_route_request_headers_module.rst.txt index 5d5e26a..5e28e7e 100644 --- a/docs/_sources/edge_route_request_headers_module.rst.txt +++ b/docs/_sources/edge_route_request_headers_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Request Headers Module ===================================== diff --git a/docs/_sources/edge_route_response_headers_module.rst.txt b/docs/_sources/edge_route_response_headers_module.rst.txt index 479644b..97156e9 100644 --- a/docs/_sources/edge_route_response_headers_module.rst.txt +++ b/docs/_sources/edge_route_response_headers_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Response Headers Module ===================================== diff --git a/docs/_sources/edge_route_saml_module.rst.txt b/docs/_sources/edge_route_saml_module.rst.txt index aba3e12..4bd60c6 100644 --- a/docs/_sources/edge_route_saml_module.rst.txt +++ b/docs/_sources/edge_route_saml_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route SAML Module ===================================== diff --git a/docs/_sources/edge_route_webhook_verification_module.rst.txt b/docs/_sources/edge_route_webhook_verification_module.rst.txt index 0cfc3fa..f42c30e 100644 --- a/docs/_sources/edge_route_webhook_verification_module.rst.txt +++ b/docs/_sources/edge_route_webhook_verification_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Webhook Verification Module ===================================== diff --git a/docs/_sources/edge_route_websocket_tcp_converter_module.rst.txt b/docs/_sources/edge_route_websocket_tcp_converter_module.rst.txt index 4436c86..a586b27 100644 --- a/docs/_sources/edge_route_websocket_tcp_converter_module.rst.txt +++ b/docs/_sources/edge_route_websocket_tcp_converter_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Route Websocket TCP Converter Module ===================================== diff --git a/docs/_sources/edges_https.rst.txt b/docs/_sources/edges_https.rst.txt index c8bbe29..1e09836 100644 --- a/docs/_sources/edges_https.rst.txt +++ b/docs/_sources/edges_https.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edges ===================================== diff --git a/docs/_sources/edges_https_routes.rst.txt b/docs/_sources/edges_https_routes.rst.txt index afb0ce7..c2ecc23 100644 --- a/docs/_sources/edges_https_routes.rst.txt +++ b/docs/_sources/edges_https_routes.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Routes ===================================== diff --git a/docs/_sources/edges_tcp.rst.txt b/docs/_sources/edges_tcp.rst.txt index b10e177..4361561 100644 --- a/docs/_sources/edges_tcp.rst.txt +++ b/docs/_sources/edges_tcp.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TCP Edges ===================================== diff --git a/docs/_sources/edges_tls.rst.txt b/docs/_sources/edges_tls.rst.txt index 4b163d1..cbf751a 100644 --- a/docs/_sources/edges_tls.rst.txt +++ b/docs/_sources/edges_tls.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edges ===================================== diff --git a/docs/_sources/endpoints.rst.txt b/docs/_sources/endpoints.rst.txt index 227a642..f15e5e4 100644 --- a/docs/_sources/endpoints.rst.txt +++ b/docs/_sources/endpoints.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Endpoints ===================================== diff --git a/docs/_sources/errors.rst.txt b/docs/_sources/errors.rst.txt index 301a65e..5b03e51 100644 --- a/docs/_sources/errors.rst.txt +++ b/docs/_sources/errors.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + .. _errors: Errors diff --git a/docs/_sources/event_destinations.rst.txt b/docs/_sources/event_destinations.rst.txt index b05b317..c674b45 100644 --- a/docs/_sources/event_destinations.rst.txt +++ b/docs/_sources/event_destinations.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Event Destinations ===================================== diff --git a/docs/_sources/event_sources.rst.txt b/docs/_sources/event_sources.rst.txt index f096cc0..82541e8 100644 --- a/docs/_sources/event_sources.rst.txt +++ b/docs/_sources/event_sources.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Event Sources ===================================== diff --git a/docs/_sources/event_subscriptions.rst.txt b/docs/_sources/event_subscriptions.rst.txt index 89bc463..1fab08b 100644 --- a/docs/_sources/event_subscriptions.rst.txt +++ b/docs/_sources/event_subscriptions.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Event Subscriptions ===================================== diff --git a/docs/_sources/failover_backends.rst.txt b/docs/_sources/failover_backends.rst.txt index 9f8905c..9437ab7 100644 --- a/docs/_sources/failover_backends.rst.txt +++ b/docs/_sources/failover_backends.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Failover Backends ===================================== diff --git a/docs/_sources/http_response_backends.rst.txt b/docs/_sources/http_response_backends.rst.txt index 006e269..23e36d3 100644 --- a/docs/_sources/http_response_backends.rst.txt +++ b/docs/_sources/http_response_backends.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTP Response Backends ===================================== diff --git a/docs/_sources/https_edge_mutual_tls_module.rst.txt b/docs/_sources/https_edge_mutual_tls_module.rst.txt index 96a49a1..b64666d 100644 --- a/docs/_sources/https_edge_mutual_tls_module.rst.txt +++ b/docs/_sources/https_edge_mutual_tls_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge Mutual TLS Module ===================================== diff --git a/docs/_sources/https_edge_tls_termination_module.rst.txt b/docs/_sources/https_edge_tls_termination_module.rst.txt index 48c8b98..8aa2e66 100644 --- a/docs/_sources/https_edge_tls_termination_module.rst.txt +++ b/docs/_sources/https_edge_tls_termination_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + HTTPS Edge TLS Termination Module ===================================== diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index 35697fc..1fce46a 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + ngrok-api ######### @@ -125,6 +128,7 @@ API Reference api_keys application_sessions application_users + tunnel_sessions failover_backends http_response_backends tunnel_group_backends @@ -168,5 +172,4 @@ API Reference ssh_host_certificates ssh_user_certificates tls_certificates - tunnel_sessions tunnels diff --git a/docs/_sources/ip_policies.rst.txt b/docs/_sources/ip_policies.rst.txt index 1799260..1b3cde8 100644 --- a/docs/_sources/ip_policies.rst.txt +++ b/docs/_sources/ip_policies.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + IP Policies ===================================== diff --git a/docs/_sources/ip_policy_rules.rst.txt b/docs/_sources/ip_policy_rules.rst.txt index c109f93..52b22a4 100644 --- a/docs/_sources/ip_policy_rules.rst.txt +++ b/docs/_sources/ip_policy_rules.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + IP Policy Rules ===================================== diff --git a/docs/_sources/ip_restrictions.rst.txt b/docs/_sources/ip_restrictions.rst.txt index 6593c97..5d5f3bc 100644 --- a/docs/_sources/ip_restrictions.rst.txt +++ b/docs/_sources/ip_restrictions.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + IP Restrictions ===================================== diff --git a/docs/_sources/reserved_addrs.rst.txt b/docs/_sources/reserved_addrs.rst.txt index aaf4f40..e00b300 100644 --- a/docs/_sources/reserved_addrs.rst.txt +++ b/docs/_sources/reserved_addrs.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Reserved Addresses ===================================== diff --git a/docs/_sources/reserved_domains.rst.txt b/docs/_sources/reserved_domains.rst.txt index c1630b5..86758eb 100644 --- a/docs/_sources/reserved_domains.rst.txt +++ b/docs/_sources/reserved_domains.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Reserved Domains ===================================== diff --git a/docs/_sources/ssh_certificate_authorities.rst.txt b/docs/_sources/ssh_certificate_authorities.rst.txt index 4bf9cd9..24dbf76 100644 --- a/docs/_sources/ssh_certificate_authorities.rst.txt +++ b/docs/_sources/ssh_certificate_authorities.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + SSH Certificate Authorities ===================================== diff --git a/docs/_sources/ssh_credentials.rst.txt b/docs/_sources/ssh_credentials.rst.txt index 06044bf..c73991a 100644 --- a/docs/_sources/ssh_credentials.rst.txt +++ b/docs/_sources/ssh_credentials.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + SSH Credentials ===================================== diff --git a/docs/_sources/ssh_host_certificates.rst.txt b/docs/_sources/ssh_host_certificates.rst.txt index 9e0b6db..e3387c1 100644 --- a/docs/_sources/ssh_host_certificates.rst.txt +++ b/docs/_sources/ssh_host_certificates.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + SSH Host Certificates ===================================== diff --git a/docs/_sources/ssh_user_certificates.rst.txt b/docs/_sources/ssh_user_certificates.rst.txt index 4cb5fee..e63abae 100644 --- a/docs/_sources/ssh_user_certificates.rst.txt +++ b/docs/_sources/ssh_user_certificates.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + SSH User Certificates ===================================== diff --git a/docs/_sources/tcp_edge_backend_module.rst.txt b/docs/_sources/tcp_edge_backend_module.rst.txt index 636003c..98b2a5f 100644 --- a/docs/_sources/tcp_edge_backend_module.rst.txt +++ b/docs/_sources/tcp_edge_backend_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TCP Edge Backend Module ===================================== diff --git a/docs/_sources/tcp_edge_ip_restriction_module.rst.txt b/docs/_sources/tcp_edge_ip_restriction_module.rst.txt index f847cc5..24810b1 100644 --- a/docs/_sources/tcp_edge_ip_restriction_module.rst.txt +++ b/docs/_sources/tcp_edge_ip_restriction_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TCP Edge IP Restriction Module ===================================== diff --git a/docs/_sources/tls_certificates.rst.txt b/docs/_sources/tls_certificates.rst.txt index a664ecc..eb06183 100644 --- a/docs/_sources/tls_certificates.rst.txt +++ b/docs/_sources/tls_certificates.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Certificates ===================================== diff --git a/docs/_sources/tls_edge_backend_module.rst.txt b/docs/_sources/tls_edge_backend_module.rst.txt index 1aa9ef6..8abf12f 100644 --- a/docs/_sources/tls_edge_backend_module.rst.txt +++ b/docs/_sources/tls_edge_backend_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edge Backend Module ===================================== diff --git a/docs/_sources/tls_edge_ip_restriction_module.rst.txt b/docs/_sources/tls_edge_ip_restriction_module.rst.txt index ed49b58..b9d14c9 100644 --- a/docs/_sources/tls_edge_ip_restriction_module.rst.txt +++ b/docs/_sources/tls_edge_ip_restriction_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edge IP Restriction Module ===================================== diff --git a/docs/_sources/tls_edge_mutual_tls_module.rst.txt b/docs/_sources/tls_edge_mutual_tls_module.rst.txt index bee4644..f8ff76d 100644 --- a/docs/_sources/tls_edge_mutual_tls_module.rst.txt +++ b/docs/_sources/tls_edge_mutual_tls_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edge Mutual TLS Module ===================================== diff --git a/docs/_sources/tls_edge_tls_termination_module.rst.txt b/docs/_sources/tls_edge_tls_termination_module.rst.txt index 55c4d52..60189de 100644 --- a/docs/_sources/tls_edge_tls_termination_module.rst.txt +++ b/docs/_sources/tls_edge_tls_termination_module.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + TLS Edge TLS Termination Module ===================================== diff --git a/docs/_sources/tunnel_group_backends.rst.txt b/docs/_sources/tunnel_group_backends.rst.txt index 0f0acac..6b997cf 100644 --- a/docs/_sources/tunnel_group_backends.rst.txt +++ b/docs/_sources/tunnel_group_backends.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Tunnel Group Backends ===================================== diff --git a/docs/_sources/tunnel_sessions.rst.txt b/docs/_sources/tunnel_sessions.rst.txt index d03189a..5d5b640 100644 --- a/docs/_sources/tunnel_sessions.rst.txt +++ b/docs/_sources/tunnel_sessions.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Tunnel Sessions ===================================== diff --git a/docs/_sources/tunnels.rst.txt b/docs/_sources/tunnels.rst.txt index 347285b..e3cad8a 100644 --- a/docs/_sources/tunnels.rst.txt +++ b/docs/_sources/tunnels.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Tunnels ===================================== diff --git a/docs/_sources/weighted_backends.rst.txt b/docs/_sources/weighted_backends.rst.txt index f9781bd..496f0c8 100644 --- a/docs/_sources/weighted_backends.rst.txt +++ b/docs/_sources/weighted_backends.rst.txt @@ -1,3 +1,6 @@ +.. + Code generated for API Clients. DO NOT EDIT. + Weighted Backends ===================================== diff --git a/docs/_static/pygments.css b/docs/_static/pygments.css index 7547150..c2e07c7 100644 --- a/docs/_static/pygments.css +++ b/docs/_static/pygments.css @@ -22,6 +22,7 @@ .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ .highlight .gd { color: #a40000 } /* Generic.Deleted */ .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ .highlight .gr { color: #ef2929 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ @@ -101,12 +102,13 @@ body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */ body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */ body[data-theme="dark"] .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ body[data-theme="dark"] .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body[data-theme="dark"] .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */ +body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ @@ -186,12 +188,13 @@ body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */ body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */ body:not([data-theme="light"]) .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ body:not([data-theme="light"]) .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body:not([data-theme="light"]) .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */ +body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ diff --git a/docs/abuse_reports.html b/docs/abuse_reports.html index 2ba71bd..9012b5a 100644 --- a/docs/abuse_reports.html +++ b/docs/abuse_reports.html @@ -167,6 +167,7 @@
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -210,7 +211,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • diff --git a/docs/agent_ingresses.html b/docs/agent_ingresses.html index 4494564..d7a83d0 100644 --- a/docs/agent_ingresses.html +++ b/docs/agent_ingresses.html @@ -167,6 +167,7 @@
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -210,7 +211,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • diff --git a/docs/api_keys.html b/docs/api_keys.html index e758724..b11bbc2 100644 --- a/docs/api_keys.html +++ b/docs/api_keys.html @@ -167,6 +167,7 @@
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -210,7 +211,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • diff --git a/docs/application_sessions.html b/docs/application_sessions.html index 6918c76..1dd912f 100644 --- a/docs/application_sessions.html +++ b/docs/application_sessions.html @@ -167,6 +167,7 @@
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -210,7 +211,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • diff --git a/docs/application_users.html b/docs/application_users.html index cb5e889..9b3f54c 100644 --- a/docs/application_users.html +++ b/docs/application_users.html @@ -3,7 +3,7 @@ - + Application Users - ngrok-api documentation @@ -167,6 +167,7 @@
  • API Keys
  • Application Sessions
  • Application Users
  • +
  • Tunnel Sessions
  • Failover Backends
  • HTTP Response Backends
  • Tunnel Group Backends
  • @@ -210,7 +211,6 @@
  • SSH Host Certificates
  • SSH User Certificates
  • TLS Certificates
  • -
  • Tunnel Sessions
  • Tunnels
  • @@ -311,12 +311,12 @@