mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-05-17 16:50:36 +00:00
Merge pull request #11 from ngrok/staging
cut new release for ngrok-api-python
This commit is contained in:
Alan Shreve
GitHub
@@ -23,7 +23,7 @@ Please consult the [documentation](https://python-api.docs.ngrok.com) for additi
|
||||
ng = ngrok.Client("<API KEY>")
|
||||
|
||||
# list all online tunnels
|
||||
for t in ng.tunnels():
|
||||
for t in ng.tunnels.list():
|
||||
print(t)
|
||||
|
||||
# create an ip policy the allows traffic from some subnets
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
Event Sources
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.event_sources` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: EventSourcesClient
|
||||
:undoc-members: EventSourcesClient
|
||||
@@ -0,0 +1,9 @@
|
||||
Event Subscriptions
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.event_subscriptions` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: EventSubscriptionsClient
|
||||
:undoc-members: EventSubscriptionsClient
|
||||
@@ -41,10 +41,10 @@ object. That's it!
|
||||
policy = ng.ip_policies.create(action="allow")
|
||||
for cidr in ["24.0.0.0/8", "12.0.0.0/8"]:
|
||||
ng.ip_policy_rules.create(cidr=cidr, ip_policy_id=policy.id)
|
||||
|
||||
|
||||
Transparent Paging
|
||||
------------------
|
||||
|
||||
Automatic Paging
|
||||
----------------
|
||||
|
||||
The ngrok API pages all list resources but this library abstracts that away
|
||||
from you. All response objects from any ``list()`` methods return an object that
|
||||
@@ -120,13 +120,15 @@ API Reference
|
||||
api_keys
|
||||
certificate_authorities
|
||||
credentials
|
||||
endpoint_configurations
|
||||
event_streams
|
||||
event_destinations
|
||||
event_subscriptions
|
||||
event_sources
|
||||
ip_policies
|
||||
ip_policy_rules
|
||||
ip_restrictions
|
||||
ip_whitelist
|
||||
endpoint_configurations
|
||||
endpoint_logging_module
|
||||
endpoint_circuit_breaker_module
|
||||
endpoint_compression_module
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="../certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../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="../ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="../../certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../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="../../ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -174,20 +176,43 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">abuse_reports</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">AbuseReportsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Abuse Reports allow you to submit take-down requests for URLs hosted by</span>
|
||||
<span class="sd"> ngrok that violate ngrok's terms of service."""</span>
|
||||
<span class="k">return</span> <span class="n">AbuseReportsClient</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">api_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">APIKeysClient</span><span class="p">:</span>
|
||||
<span class="sd">"""API Keys are used to authenticate to the `ngrok</span>
|
||||
<span class="sd"> API` <https://ngrok.com/docs/api#authentication>`_. You may use the API itself</span>
|
||||
<span class="sd"> to provision and manage API Keys but you'll need to provision your first API</span>
|
||||
<span class="sd"> key from the `API Keys page` <https://dashboard.ngrok.com/api/keys>`_ on your</span>
|
||||
<span class="sd"> ngrok.com dashboard."""</span>
|
||||
<span class="k">return</span> <span class="n">APIKeysClient</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="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>
|
||||
<span class="sd"> to verify that the TLS certificate presented by a client has been signed by</span>
|
||||
<span class="sd"> this CA. Certificate Authorities are used only for mTLS validation only and</span>
|
||||
<span class="sd"> thus a private key is not included in the resource."""</span>
|
||||
<span class="k">return</span> <span class="n">CertificateAuthoritiesClient</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">credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">CredentialsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</span>
|
||||
<span class="sd"> agent to connect the ngrok service as your account. They are installed with</span>
|
||||
<span class="sd"> the ``ngrok authtoken`` command or by specifying it in the ``ngrok.yml``</span>
|
||||
<span class="sd"> configuration file with the ``authtoken`` property."""</span>
|
||||
<span class="k">return</span> <span class="n">CredentialsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">endpoint_configurations</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointConfigurationsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Endpoint Configurations are a reusable group of modules that encapsulate how</span>
|
||||
<span class="sd"> traffic to a domain or address is handled. Endpoint configurations are only</span>
|
||||
<span class="sd"> applied to Domains and TCP Addresses they have been attached to."""</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfigurationsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">event_streams</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EventStreamsClient</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">EventStreamsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
@@ -196,62 +221,105 @@
|
||||
<span class="k">def</span> <span class="nf">event_destinations</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EventDestinationsClient</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">EventDestinationsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">event_subscriptions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EventSubscriptionsClient</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">EventSubscriptionsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">event_sources</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EventSourcesClient</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">EventSourcesClient</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">ip_policies</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">IPPoliciesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``</span>
|
||||
<span class="sd"> action. They can be attached to endpoints via the Endpoint Configuration IP</span>
|
||||
<span class="sd"> Policy module. They can also be used with IP Restrictions to control source</span>
|
||||
<span class="sd"> IP ranges that can start tunnel sessions and connect to the API and dashboard."""</span>
|
||||
<span class="k">return</span> <span class="n">IPPoliciesClient</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">ip_policy_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">IPPolicyRulesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</span>
|
||||
<span class="sd"> make up an IP Policy."""</span>
|
||||
<span class="k">return</span> <span class="n">IPPolicyRulesClient</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">ip_restrictions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">IPRestrictionsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""An IP restriction is a restriction placed on the CIDRs that are allowed to</span>
|
||||
<span class="sd"> initate traffic to a specific aspect of your ngrok account. An IP</span>
|
||||
<span class="sd"> restriction has a type which defines the ingress it applies to. IP</span>
|
||||
<span class="sd"> restrictions can be used to enforce the source IPs that can make API</span>
|
||||
<span class="sd"> requests, log in to the dashboard, start ngrok agents, and connect to your</span>
|
||||
<span class="sd"> public-facing endpoints."""</span>
|
||||
<span class="k">return</span> <span class="n">IPRestrictionsClient</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">ip_whitelist</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">IPWhitelistClient</span><span class="p">:</span>
|
||||
<span class="sd">"""The IP Whitelist is deprecated and will be removed. Use an IP Restriction</span>
|
||||
<span class="sd"> with an ``endpoints`` type instead."""</span>
|
||||
<span class="k">return</span> <span class="n">IPWhitelistClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">endpoint_configurations</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointConfigurationsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Endpoint Configuration managementAn `Endpoint Configuration` <https://ngrok.com/docs/ngrok-link#api-endpoint-configurations>`_ describes</span>
|
||||
<span class="sd"> a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!*"""</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfigurationsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">reserved_addrs</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">ReservedAddrsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Reserved Addresses are TCP addresses that can be used to listen for traffic.</span>
|
||||
<span class="sd"> TCP address hostnames and ports are assigned by ngrok, they cannot be</span>
|
||||
<span class="sd"> chosen."""</span>
|
||||
<span class="k">return</span> <span class="n">ReservedAddrsClient</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">reserved_domains</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">ReservedDomainsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Reserved Domains are hostnames that you can listen for traffic on. Domains</span>
|
||||
<span class="sd"> can be used to listen for http, https or tls traffic. You may use a domain</span>
|
||||
<span class="sd"> that you own by creating a CNAME record specified in the returned resource.</span>
|
||||
<span class="sd"> This CNAME record points traffic for that domain to ngrok's edge servers."""</span>
|
||||
<span class="k">return</span> <span class="n">ReservedDomainsClient</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">ssh_certificate_authorities</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SSHCertificateAuthoritiesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""An SSH Certificate Authority is a pair of an SSH Certificate and its private</span>
|
||||
<span class="sd"> key that can be used to sign other SSH host and user certificates."""</span>
|
||||
<span class="k">return</span> <span class="n">SSHCertificateAuthoritiesClient</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">ssh_credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SSHCredentialsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""SSH Credentials are SSH public keys that can be used to start SSH tunnels</span>
|
||||
<span class="sd"> via the ngrok SSH tunnel gateway."""</span>
|
||||
<span class="k">return</span> <span class="n">SSHCredentialsClient</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">ssh_host_certificates</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SSHHostCertificatesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""SSH Host Certificates along with the corresponding private key allows an SSH</span>
|
||||
<span class="sd"> server to assert its authenticity to connecting SSH clients who trust the</span>
|
||||
<span class="sd"> SSH Certificate Authority that was used to sign the certificate."""</span>
|
||||
<span class="k">return</span> <span class="n">SSHHostCertificatesClient</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">ssh_user_certificates</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SSHUserCertificatesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""SSH User Certificates are presented by SSH clients when connecting to an SSH</span>
|
||||
<span class="sd"> server to authenticate their connection. The SSH server must trust the SSH</span>
|
||||
<span class="sd"> Certificate Authority used to sign the certificate."""</span>
|
||||
<span class="k">return</span> <span class="n">SSHUserCertificatesClient</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">tls_certificates</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TLSCertificatesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""TLS Certificates are pairs of x509 certificates and their matching private</span>
|
||||
<span class="sd"> key that can be used to terminate TLS traffic. TLS certificates are unused</span>
|
||||
<span class="sd"> until they are attached to a Domain. TLS Certificates may also be</span>
|
||||
<span class="sd"> provisioned by ngrok automatically for domains on which you have enabled</span>
|
||||
<span class="sd"> automated certificate provisioning."""</span>
|
||||
<span class="k">return</span> <span class="n">TLSCertificatesClient</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">tunnel_sessions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TunnelSessionsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</span>
|
||||
<span class="sd"> sessions that are running and connected to the ngrok service. Each tunnel</span>
|
||||
<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">tunnels</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TunnelsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Tunnels provide endpoints to access services exposed by a running ngrok</span>
|
||||
<span class="sd"> agent tunnel session or an SSH reverse tunnel session."""</span>
|
||||
<span class="k">return</span> <span class="n">TunnelsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
|
||||
+1257
-893
File diff suppressed because it is too large
Load Diff
@@ -119,13 +119,15 @@
|
||||
<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="../../certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../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="../../ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
+495
-192
@@ -119,13 +119,15 @@
|
||||
<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="../../certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../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="../../ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -171,6 +173,9 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="AbuseReportsClient"><a class="viewcode-back" href="../../abuse_reports.html#ngrok.services.AbuseReportsClient">[docs]</a><span class="k">class</span> <span class="nc">AbuseReportsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""Abuse Reports allow you to submit take-down requests for URLs hosted by</span>
|
||||
<span class="sd"> ngrok that violate ngrok's terms of service."""</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>
|
||||
|
||||
@@ -215,6 +220,12 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="APIKeysClient"><a class="viewcode-back" href="../../api_keys.html#ngrok.services.APIKeysClient">[docs]</a><span class="k">class</span> <span class="nc">APIKeysClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""API Keys are used to authenticate to the `ngrok</span>
|
||||
<span class="sd"> API` <https://ngrok.com/docs/api#authentication>`_. You may use the API itself</span>
|
||||
<span class="sd"> to provision and manage API Keys but you'll need to provision your first API</span>
|
||||
<span class="sd"> key from the `API Keys page` <https://dashboard.ngrok.com/api/keys>`_ on your</span>
|
||||
<span class="sd"> ngrok.com dashboard."""</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>
|
||||
|
||||
@@ -324,6 +335,12 @@
|
||||
|
||||
|
||||
<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="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>
|
||||
<span class="sd"> to verify that the TLS certificate presented by a client has been signed by</span>
|
||||
<span class="sd"> this CA. Certificate Authorities are used only for mTLS validation only and</span>
|
||||
<span class="sd"> thus a private key is not included in the resource."""</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>
|
||||
|
||||
@@ -436,6 +453,11 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="CredentialsClient"><a class="viewcode-back" href="../../credentials.html#ngrok.services.CredentialsClient">[docs]</a><span class="k">class</span> <span class="nc">CredentialsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</span>
|
||||
<span class="sd"> agent to connect the ngrok service as your account. They are installed with</span>
|
||||
<span class="sd"> the ``ngrok authtoken`` command or by specifying it in the ``ngrok.yml``</span>
|
||||
<span class="sd"> configuration file with the ``authtoken`` property."""</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>
|
||||
|
||||
@@ -550,6 +572,194 @@
|
||||
<span class="k">return</span> <span class="n">Credential</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="EndpointConfigurationsClient"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointConfigurationsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""Endpoint Configurations are a reusable group of modules that encapsulate how</span>
|
||||
<span class="sd"> traffic to a domain or address is handled. Endpoint configurations are only</span>
|
||||
<span class="sd"> applied to Domains and TCP Addresses they have been attached to."""</span>
|
||||
|
||||
<span class="k">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="EndpointConfigurationsClient.create"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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="nb">type</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">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">circuit_breaker</span><span class="p">:</span> <span class="n">EndpointCircuitBreaker</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="p">:</span> <span class="n">EndpointCompression</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">request_headers</span><span class="p">:</span> <span class="n">EndpointRequestHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">response_headers</span><span class="p">:</span> <span class="n">EndpointResponseHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">ip_policy</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">webhook_validation</span><span class="p">:</span> <span class="n">EndpointWebhookValidation</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">oauth</span><span class="p">:</span> <span class="n">EndpointOAuth</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">logging</span><span class="p">:</span> <span class="n">EndpointLoggingMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<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="p">)</span> <span class="o">-></span> <span class="n">EndpointConfiguration</span><span class="p">:</span>
|
||||
<span class="sd">"""Create a new endpoint configuration</span>
|
||||
|
||||
<span class="sd"> :param type: they type of traffic this endpoint configuration can be applied to. one of: ``http``, ``https``, ``tcp``</span>
|
||||
<span class="sd"> :param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</span>
|
||||
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</span>
|
||||
<span class="sd"> :param circuit_breaker: circuit breaker module configuration or ``null``</span>
|
||||
<span class="sd"> :param compression: compression module configuration or ``null``</span>
|
||||
<span class="sd"> :param request_headers: request headers module configuration or ``null``</span>
|
||||
<span class="sd"> :param response_headers: response headers module configuration or ``null``</span>
|
||||
<span class="sd"> :param ip_policy: ip policy module configuration or ``null``</span>
|
||||
<span class="sd"> :param mutual_tls: mutual TLS module configuration or ``null``</span>
|
||||
<span class="sd"> :param tls_termination: TLS termination module configuration or ``null``</span>
|
||||
<span class="sd"> :param webhook_validation: webhook validation module configuration or ``null``</span>
|
||||
<span class="sd"> :param oauth: oauth module configuration or ``null``</span>
|
||||
<span class="sd"> :param logging: logging module configuration or ``null``</span>
|
||||
<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"> https://ngrok.com/docs/api#api-endpoint-configurations-create</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations"</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="nb">dict</span><span class="p">(</span>
|
||||
<span class="nb">type</span><span class="o">=</span><span class="nb">type</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">circuit_breaker</span><span class="o">=</span><span class="n">circuit_breaker</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="o">=</span><span class="n">compression</span><span class="p">,</span>
|
||||
<span class="n">request_headers</span><span class="o">=</span><span class="n">request_headers</span><span class="p">,</span>
|
||||
<span class="n">response_headers</span><span class="o">=</span><span class="n">response_headers</span><span class="p">,</span>
|
||||
<span class="n">ip_policy</span><span class="o">=</span><span class="n">ip_policy</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">webhook_validation</span><span class="o">=</span><span class="n">webhook_validation</span><span class="p">,</span>
|
||||
<span class="n">oauth</span><span class="o">=</span><span class="n">oauth</span><span class="p">,</span>
|
||||
<span class="n">logging</span><span class="o">=</span><span class="n">logging</span><span class="p">,</span>
|
||||
<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="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfiguration</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="EndpointConfigurationsClient.delete"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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="sd">"""Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-configurations-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</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="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="nb">dict</span><span class="p">())</span></div>
|
||||
|
||||
<div class="viewcode-block" id="EndpointConfigurationsClient.get"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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">EndpointConfiguration</span><span class="p">:</span>
|
||||
<span class="sd">"""Returns detailed information about an endpoint configuration</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-configurations-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</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">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="nb">dict</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfiguration</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="EndpointConfigurationsClient.list"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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">EndpointConfigurationList</span><span class="p">:</span>
|
||||
<span class="sd">"""Returns a list of all endpoint configurations 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-endpoint-configurations-list</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations"</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="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="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfigurationList</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="EndpointConfigurationsClient.update"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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">circuit_breaker</span><span class="p">:</span> <span class="n">EndpointCircuitBreaker</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="p">:</span> <span class="n">EndpointCompression</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">request_headers</span><span class="p">:</span> <span class="n">EndpointRequestHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">response_headers</span><span class="p">:</span> <span class="n">EndpointResponseHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">ip_policy</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">webhook_validation</span><span class="p">:</span> <span class="n">EndpointWebhookValidation</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">oauth</span><span class="p">:</span> <span class="n">EndpointOAuth</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">logging</span><span class="p">:</span> <span class="n">EndpointLoggingMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<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="p">)</span> <span class="o">-></span> <span class="n">EndpointConfiguration</span><span class="p">:</span>
|
||||
<span class="sd">"""Updates an endpoint configuration. 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>
|
||||
|
||||
<span class="sd"> :param id: unique identifier of this endpoint configuration</span>
|
||||
<span class="sd"> :param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</span>
|
||||
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</span>
|
||||
<span class="sd"> :param circuit_breaker: circuit breaker module configuration or ``null``</span>
|
||||
<span class="sd"> :param compression: compression module configuration or ``null``</span>
|
||||
<span class="sd"> :param request_headers: request headers module configuration or ``null``</span>
|
||||
<span class="sd"> :param response_headers: response headers module configuration or ``null``</span>
|
||||
<span class="sd"> :param ip_policy: ip policy module configuration or ``null``</span>
|
||||
<span class="sd"> :param mutual_tls: mutual TLS module configuration or ``null``</span>
|
||||
<span class="sd"> :param tls_termination: TLS termination module configuration or ``null``</span>
|
||||
<span class="sd"> :param webhook_validation: webhook validation module configuration or ``null``</span>
|
||||
<span class="sd"> :param oauth: oauth module configuration or ``null``</span>
|
||||
<span class="sd"> :param logging: logging module configuration or ``null``</span>
|
||||
<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"> https://ngrok.com/docs/api#api-endpoint-configurations-update</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</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">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="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">circuit_breaker</span><span class="o">=</span><span class="n">circuit_breaker</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="o">=</span><span class="n">compression</span><span class="p">,</span>
|
||||
<span class="n">request_headers</span><span class="o">=</span><span class="n">request_headers</span><span class="p">,</span>
|
||||
<span class="n">response_headers</span><span class="o">=</span><span class="n">response_headers</span><span class="p">,</span>
|
||||
<span class="n">ip_policy</span><span class="o">=</span><span class="n">ip_policy</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">webhook_validation</span><span class="o">=</span><span class="n">webhook_validation</span><span class="p">,</span>
|
||||
<span class="n">oauth</span><span class="o">=</span><span class="n">oauth</span><span class="p">,</span>
|
||||
<span class="n">logging</span><span class="o">=</span><span class="n">logging</span><span class="p">,</span>
|
||||
<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="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfiguration</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="EventStreamsClient"><a class="viewcode-back" href="../../event_streams.html#ngrok.services.EventStreamsClient">[docs]</a><span class="k">class</span> <span class="nc">EventStreamsClient</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>
|
||||
@@ -801,7 +1011,238 @@
|
||||
<span class="k">return</span> <span class="n">EventDestination</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="EventSubscriptionsClient"><a class="viewcode-back" href="../../event_subscriptions.html#ngrok.services.EventSubscriptionsClient">[docs]</a><span class="k">class</span> <span class="nc">EventSubscriptionsClient</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="EventSubscriptionsClient.create"><a class="viewcode-back" href="../../event_subscriptions.html#ngrok.services.EventSubscriptionsClient.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">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">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">sources</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">EventSourceReplace</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
||||
<span class="n">destination_ids</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="p">[],</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EventSubscription</span><span class="p">:</span>
|
||||
<span class="sd">"""Create an Event Subscription.</span>
|
||||
|
||||
<span class="sd"> :param metadata: Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.</span>
|
||||
<span class="sd"> :param description: Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.</span>
|
||||
<span class="sd"> :param sources: Sources containing the types for which this event subscription will trigger</span>
|
||||
<span class="sd"> :param destination_ids: A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-subscriptions-create</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions"</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="nb">dict</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">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="n">sources</span><span class="o">=</span><span class="n">sources</span><span class="p">,</span>
|
||||
<span class="n">destination_ids</span><span class="o">=</span><span class="n">destination_ids</span><span class="p">,</span>
|
||||
<span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EventSubscription</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="EventSubscriptionsClient.delete"><a class="viewcode-back" href="../../event_subscriptions.html#ngrok.services.EventSubscriptionsClient.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="sd">"""Delete an Event Subscription.</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-subscriptions-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions/</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="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="nb">dict</span><span class="p">())</span></div>
|
||||
|
||||
<div class="viewcode-block" id="EventSubscriptionsClient.get"><a class="viewcode-back" href="../../event_subscriptions.html#ngrok.services.EventSubscriptionsClient.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">EventSubscription</span><span class="p">:</span>
|
||||
<span class="sd">"""Get an Event Subscription by ID.</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-subscriptions-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions/</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">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="nb">dict</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">EventSubscription</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="EventSubscriptionsClient.list"><a class="viewcode-back" href="../../event_subscriptions.html#ngrok.services.EventSubscriptionsClient.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">EventSubscriptionList</span><span class="p">:</span>
|
||||
<span class="sd">"""List this Account's Event Subscriptions.</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-subscriptions-list</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions"</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="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="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EventSubscriptionList</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="EventSubscriptionsClient.update"><a class="viewcode-back" href="../../event_subscriptions.html#ngrok.services.EventSubscriptionsClient.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">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">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">sources</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">EventSourceReplace</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">destination_ids</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="p">)</span> <span class="o">-></span> <span class="n">EventSubscription</span><span class="p">:</span>
|
||||
<span class="sd">"""Update an Event Subscription.</span>
|
||||
|
||||
<span class="sd"> :param id: Unique identifier for this Event Subscription.</span>
|
||||
<span class="sd"> :param metadata: Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.</span>
|
||||
<span class="sd"> :param description: Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.</span>
|
||||
<span class="sd"> :param sources: Sources containing the types for which this event subscription will trigger</span>
|
||||
<span class="sd"> :param destination_ids: A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-subscriptions-update</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions/</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">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="nb">dict</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">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="n">sources</span><span class="o">=</span><span class="n">sources</span><span class="p">,</span>
|
||||
<span class="n">destination_ids</span><span class="o">=</span><span class="n">destination_ids</span><span class="p">,</span>
|
||||
<span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EventSubscription</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="EventSourcesClient"><a class="viewcode-back" href="../../event_sources.html#ngrok.services.EventSourcesClient">[docs]</a><span class="k">class</span> <span class="nc">EventSourcesClient</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="EventSourcesClient.create"><a class="viewcode-back" href="../../event_sources.html#ngrok.services.EventSourcesClient.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">subscription_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EventSource</span><span class="p">:</span>
|
||||
<span class="sd">"""Add an additional type for which this event subscription will trigger</span>
|
||||
|
||||
<span class="sd"> :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.</span>
|
||||
<span class="sd"> :param type: Type of event for which an event subscription will trigger</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-sources-create</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions/</span><span class="si">{subscription_id}</span><span class="s2">/sources"</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">subscription_id</span><span class="o">=</span><span class="n">subscription_id</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="nb">dict</span><span class="p">(</span>
|
||||
<span class="nb">type</span><span class="o">=</span><span class="nb">type</span><span class="p">,</span>
|
||||
<span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EventSource</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="EventSourcesClient.delete"><a class="viewcode-back" href="../../event_sources.html#ngrok.services.EventSourcesClient.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">subscription_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="sd">"""Remove a type for which this event subscription will trigger</span>
|
||||
|
||||
<span class="sd"> :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.</span>
|
||||
<span class="sd"> :param type: Type of event for which an event subscription will trigger</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-sources-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions/</span><span class="si">{subscription_id}</span><span class="s2">/sources/</span><span class="si">{type}</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="n">subscription_id</span><span class="o">=</span><span class="n">subscription_id</span><span class="p">,</span>
|
||||
<span class="nb">type</span><span class="o">=</span><span class="nb">type</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">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="nb">dict</span><span class="p">())</span></div>
|
||||
|
||||
<div class="viewcode-block" id="EventSourcesClient.get"><a class="viewcode-back" href="../../event_sources.html#ngrok.services.EventSourcesClient.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">subscription_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">type</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">EventSource</span><span class="p">:</span>
|
||||
<span class="sd">"""Get the details for a given type that triggers for the given event subscription</span>
|
||||
|
||||
<span class="sd"> :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.</span>
|
||||
<span class="sd"> :param type: Type of event for which an event subscription will trigger</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-sources-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions/</span><span class="si">{subscription_id}</span><span class="s2">/sources/</span><span class="si">{type}</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="n">subscription_id</span><span class="o">=</span><span class="n">subscription_id</span><span class="p">,</span>
|
||||
<span class="nb">type</span><span class="o">=</span><span class="nb">type</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="nb">dict</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">EventSource</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="EventSourcesClient.list"><a class="viewcode-back" href="../../event_sources.html#ngrok.services.EventSourcesClient.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">subscription_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">EventSourceList</span><span class="p">:</span>
|
||||
<span class="sd">"""List the types for which this event subscription will trigger</span>
|
||||
|
||||
<span class="sd"> :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-sources-list</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions/</span><span class="si">{subscription_id}</span><span class="s2">/sources"</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">subscription_id</span><span class="o">=</span><span class="n">subscription_id</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="nb">dict</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">EventSourceList</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="EventSourcesClient.update"><a class="viewcode-back" href="../../event_sources.html#ngrok.services.EventSourcesClient.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">subscription_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="nb">type</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">EventSource</span><span class="p">:</span>
|
||||
<span class="sd">"""Update the type for which this event subscription will trigger</span>
|
||||
|
||||
<span class="sd"> :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.</span>
|
||||
<span class="sd"> :param type: Type of event for which an event subscription will trigger</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-sources-update</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_subscriptions/</span><span class="si">{subscription_id}</span><span class="s2">/sources/</span><span class="si">{type}</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="n">subscription_id</span><span class="o">=</span><span class="n">subscription_id</span><span class="p">,</span>
|
||||
<span class="nb">type</span><span class="o">=</span><span class="nb">type</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="nb">dict</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">EventSource</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="IPPoliciesClient"><a class="viewcode-back" href="../../ip_policies.html#ngrok.services.IPPoliciesClient">[docs]</a><span class="k">class</span> <span class="nc">IPPoliciesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``</span>
|
||||
<span class="sd"> action. They can be attached to endpoints via the Endpoint Configuration IP</span>
|
||||
<span class="sd"> Policy module. They can also be used with IP Restrictions to control source</span>
|
||||
<span class="sd"> IP ranges that can start tunnel sessions and connect to the API and dashboard."""</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>
|
||||
|
||||
@@ -914,6 +1355,9 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="IPPolicyRulesClient"><a class="viewcode-back" href="../../ip_policy_rules.html#ngrok.services.IPPolicyRulesClient">[docs]</a><span class="k">class</span> <span class="nc">IPPolicyRulesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</span>
|
||||
<span class="sd"> make up an IP Policy."""</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>
|
||||
|
||||
@@ -1032,6 +1476,13 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="IPRestrictionsClient"><a class="viewcode-back" href="../../ip_restrictions.html#ngrok.services.IPRestrictionsClient">[docs]</a><span class="k">class</span> <span class="nc">IPRestrictionsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""An IP restriction is a restriction placed on the CIDRs that are allowed to</span>
|
||||
<span class="sd"> initate traffic to a specific aspect of your ngrok account. An IP</span>
|
||||
<span class="sd"> restriction has a type which defines the ingress it applies to. IP</span>
|
||||
<span class="sd"> restrictions can be used to enforce the source IPs that can make API</span>
|
||||
<span class="sd"> requests, log in to the dashboard, start ngrok agents, and connect to your</span>
|
||||
<span class="sd"> public-facing endpoints."""</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>
|
||||
|
||||
@@ -1047,7 +1498,7 @@
|
||||
|
||||
<span class="sd"> :param description: human-readable description of this IP restriction. optional, max 255 bytes.</span>
|
||||
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.</span>
|
||||
<span class="sd"> :param enforced: true if the IP restriction will be enforce. if false, only warnings will be issued</span>
|
||||
<span class="sd"> :param enforced: true if the IP restriction will be enforced. if false, only warnings will be issued</span>
|
||||
<span class="sd"> :param type: the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: ``dashboard``, ``api``, ``agent``, and ``endpoints``</span>
|
||||
<span class="sd"> :param ip_policy_ids: the set of IP policy identifiers that are used to enforce the restriction</span>
|
||||
|
||||
@@ -1134,7 +1585,7 @@
|
||||
<span class="sd"> :param id:</span>
|
||||
<span class="sd"> :param description: human-readable description of this IP restriction. optional, max 255 bytes.</span>
|
||||
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.</span>
|
||||
<span class="sd"> :param enforced: true if the IP restriction will be enforce. if false, only warnings will be issued</span>
|
||||
<span class="sd"> :param enforced: true if the IP restriction will be enforced. if false, only warnings will be issued</span>
|
||||
<span class="sd"> :param ip_policy_ids: the set of IP policy identifiers that are used to enforce the restriction</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-ip-restrictions-update</span>
|
||||
@@ -1156,6 +1607,9 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="IPWhitelistClient"><a class="viewcode-back" href="../../ip_whitelist.html#ngrok.services.IPWhitelistClient">[docs]</a><span class="k">class</span> <span class="nc">IPWhitelistClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""The IP Whitelist is deprecated and will be removed. Use an IP Restriction</span>
|
||||
<span class="sd"> with an ``endpoints`` type instead."""</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>
|
||||
|
||||
@@ -1267,193 +1721,6 @@
|
||||
<span class="k">return</span> <span class="n">IPWhitelistEntry</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="EndpointConfigurationsClient"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointConfigurationsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""Endpoint Configuration managementAn `Endpoint Configuration` <https://ngrok.com/docs/ngrok-link#api-endpoint-configurations>`_ describes</span>
|
||||
<span class="sd"> a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!*"""</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="EndpointConfigurationsClient.create"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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="nb">type</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">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">circuit_breaker</span><span class="p">:</span> <span class="n">EndpointCircuitBreaker</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="p">:</span> <span class="n">EndpointCompression</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">request_headers</span><span class="p">:</span> <span class="n">EndpointRequestHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">response_headers</span><span class="p">:</span> <span class="n">EndpointResponseHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">ip_policy</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">webhook_validation</span><span class="p">:</span> <span class="n">EndpointWebhookValidation</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">oauth</span><span class="p">:</span> <span class="n">EndpointOAuth</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">logging</span><span class="p">:</span> <span class="n">EndpointLoggingMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<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="p">)</span> <span class="o">-></span> <span class="n">EndpointConfiguration</span><span class="p">:</span>
|
||||
<span class="sd">"""Create a new endpoint configuration</span>
|
||||
|
||||
<span class="sd"> :param type: they type of traffic this endpoint configuration can be applied to. one of: ``http``, ``https``, ``tcp``</span>
|
||||
<span class="sd"> :param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</span>
|
||||
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</span>
|
||||
<span class="sd"> :param circuit_breaker: circuit breaker module configuration or ``null``</span>
|
||||
<span class="sd"> :param compression: compression module configuration or ``null``</span>
|
||||
<span class="sd"> :param request_headers: request headers module configuration or ``null``</span>
|
||||
<span class="sd"> :param response_headers: response headers module configuration or ``null``</span>
|
||||
<span class="sd"> :param ip_policy: ip policy module configuration or ``null``</span>
|
||||
<span class="sd"> :param mutual_tls: mutual TLS module configuration or ``null``</span>
|
||||
<span class="sd"> :param tls_termination: TLS termination module configuration or ``null``</span>
|
||||
<span class="sd"> :param webhook_validation: webhook validation module configuration or ``null``</span>
|
||||
<span class="sd"> :param oauth: oauth module configuration or ``null``</span>
|
||||
<span class="sd"> :param logging: logging module configuration or ``null``</span>
|
||||
<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"> https://ngrok.com/docs/api#api-endpoint-configurations-create</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations"</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="nb">dict</span><span class="p">(</span>
|
||||
<span class="nb">type</span><span class="o">=</span><span class="nb">type</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">circuit_breaker</span><span class="o">=</span><span class="n">circuit_breaker</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="o">=</span><span class="n">compression</span><span class="p">,</span>
|
||||
<span class="n">request_headers</span><span class="o">=</span><span class="n">request_headers</span><span class="p">,</span>
|
||||
<span class="n">response_headers</span><span class="o">=</span><span class="n">response_headers</span><span class="p">,</span>
|
||||
<span class="n">ip_policy</span><span class="o">=</span><span class="n">ip_policy</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">webhook_validation</span><span class="o">=</span><span class="n">webhook_validation</span><span class="p">,</span>
|
||||
<span class="n">oauth</span><span class="o">=</span><span class="n">oauth</span><span class="p">,</span>
|
||||
<span class="n">logging</span><span class="o">=</span><span class="n">logging</span><span class="p">,</span>
|
||||
<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="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfiguration</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="EndpointConfigurationsClient.delete"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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="sd">"""Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-configurations-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</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="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="nb">dict</span><span class="p">())</span></div>
|
||||
|
||||
<div class="viewcode-block" id="EndpointConfigurationsClient.get"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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">EndpointConfiguration</span><span class="p">:</span>
|
||||
<span class="sd">"""Returns detailed information about an endpoint configuration</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-configurations-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</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">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="nb">dict</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfiguration</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="EndpointConfigurationsClient.list"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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">EndpointConfigurationList</span><span class="p">:</span>
|
||||
<span class="sd">"""Returns a list of all endpoint configurations 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-endpoint-configurations-list</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations"</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="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="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfigurationList</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="EndpointConfigurationsClient.update"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.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">circuit_breaker</span><span class="p">:</span> <span class="n">EndpointCircuitBreaker</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="p">:</span> <span class="n">EndpointCompression</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">request_headers</span><span class="p">:</span> <span class="n">EndpointRequestHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">response_headers</span><span class="p">:</span> <span class="n">EndpointResponseHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">ip_policy</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">webhook_validation</span><span class="p">:</span> <span class="n">EndpointWebhookValidation</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">oauth</span><span class="p">:</span> <span class="n">EndpointOAuth</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">logging</span><span class="p">:</span> <span class="n">EndpointLoggingMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<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="p">)</span> <span class="o">-></span> <span class="n">EndpointConfiguration</span><span class="p">:</span>
|
||||
<span class="sd">"""Updates an endpoint configuration. 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>
|
||||
|
||||
<span class="sd"> :param id: unique identifier of this endpoint configuration</span>
|
||||
<span class="sd"> :param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</span>
|
||||
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</span>
|
||||
<span class="sd"> :param circuit_breaker: circuit breaker module configuration or ``null``</span>
|
||||
<span class="sd"> :param compression: compression module configuration or ``null``</span>
|
||||
<span class="sd"> :param request_headers: request headers module configuration or ``null``</span>
|
||||
<span class="sd"> :param response_headers: response headers module configuration or ``null``</span>
|
||||
<span class="sd"> :param ip_policy: ip policy module configuration or ``null``</span>
|
||||
<span class="sd"> :param mutual_tls: mutual TLS module configuration or ``null``</span>
|
||||
<span class="sd"> :param tls_termination: TLS termination module configuration or ``null``</span>
|
||||
<span class="sd"> :param webhook_validation: webhook validation module configuration or ``null``</span>
|
||||
<span class="sd"> :param oauth: oauth module configuration or ``null``</span>
|
||||
<span class="sd"> :param logging: logging module configuration or ``null``</span>
|
||||
<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"> https://ngrok.com/docs/api#api-endpoint-configurations-update</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</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">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="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">circuit_breaker</span><span class="o">=</span><span class="n">circuit_breaker</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="o">=</span><span class="n">compression</span><span class="p">,</span>
|
||||
<span class="n">request_headers</span><span class="o">=</span><span class="n">request_headers</span><span class="p">,</span>
|
||||
<span class="n">response_headers</span><span class="o">=</span><span class="n">response_headers</span><span class="p">,</span>
|
||||
<span class="n">ip_policy</span><span class="o">=</span><span class="n">ip_policy</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">webhook_validation</span><span class="o">=</span><span class="n">webhook_validation</span><span class="p">,</span>
|
||||
<span class="n">oauth</span><span class="o">=</span><span class="n">oauth</span><span class="p">,</span>
|
||||
<span class="n">logging</span><span class="o">=</span><span class="n">logging</span><span class="p">,</span>
|
||||
<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="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointConfiguration</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="EndpointLoggingModuleClient"><a class="viewcode-back" href="../../endpoint_logging_module.html#ngrok.services.EndpointLoggingModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointLoggingModuleClient</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>
|
||||
@@ -2199,6 +2466,10 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ReservedAddrsClient"><a class="viewcode-back" href="../../reserved_addrs.html#ngrok.services.ReservedAddrsClient">[docs]</a><span class="k">class</span> <span class="nc">ReservedAddrsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""Reserved Addresses are TCP addresses that can be used to listen for traffic.</span>
|
||||
<span class="sd"> TCP address hostnames and ports are assigned by ngrok, they cannot be</span>
|
||||
<span class="sd"> chosen."""</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>
|
||||
|
||||
@@ -2333,6 +2604,11 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ReservedDomainsClient"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient">[docs]</a><span class="k">class</span> <span class="nc">ReservedDomainsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""Reserved Domains are hostnames that you can listen for traffic on. Domains</span>
|
||||
<span class="sd"> can be used to listen for http, https or tls traffic. You may use a domain</span>
|
||||
<span class="sd"> that you own by creating a CNAME record specified in the returned resource.</span>
|
||||
<span class="sd"> This CNAME record points traffic for that domain to ngrok's edge servers."""</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>
|
||||
|
||||
@@ -2342,8 +2618,8 @@
|
||||
<span class="n">region</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">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">http_endpoint_configuration_id</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">https_endpoint_configuration_id</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">http_endpoint_configuration_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">https_endpoint_configuration_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">certificate_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">certificate_management_policy</span><span class="p">:</span> <span class="n">ReservedDomainCertPolicy</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">ReservedDomain</span><span class="p">:</span>
|
||||
@@ -2536,6 +2812,9 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SSHCertificateAuthoritiesClient"><a class="viewcode-back" href="../../ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient">[docs]</a><span class="k">class</span> <span class="nc">SSHCertificateAuthoritiesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""An SSH Certificate Authority is a pair of an SSH Certificate and its private</span>
|
||||
<span class="sd"> key that can be used to sign other SSH host and user certificates."""</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>
|
||||
|
||||
@@ -2654,6 +2933,9 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SSHCredentialsClient"><a class="viewcode-back" href="../../ssh_credentials.html#ngrok.services.SSHCredentialsClient">[docs]</a><span class="k">class</span> <span class="nc">SSHCredentialsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""SSH Credentials are SSH public keys that can be used to start SSH tunnels</span>
|
||||
<span class="sd"> via the ngrok SSH tunnel gateway."""</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>
|
||||
|
||||
@@ -2772,6 +3054,10 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SSHHostCertificatesClient"><a class="viewcode-back" href="../../ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient">[docs]</a><span class="k">class</span> <span class="nc">SSHHostCertificatesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""SSH Host Certificates along with the corresponding private key allows an SSH</span>
|
||||
<span class="sd"> server to assert its authenticity to connecting SSH clients who trust the</span>
|
||||
<span class="sd"> SSH Certificate Authority that was used to sign the certificate."""</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>
|
||||
|
||||
@@ -2896,6 +3182,10 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SSHUserCertificatesClient"><a class="viewcode-back" href="../../ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient">[docs]</a><span class="k">class</span> <span class="nc">SSHUserCertificatesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""SSH User Certificates are presented by SSH clients when connecting to an SSH</span>
|
||||
<span class="sd"> server to authenticate their connection. The SSH server must trust the SSH</span>
|
||||
<span class="sd"> Certificate Authority used to sign the certificate."""</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>
|
||||
|
||||
@@ -3026,6 +3316,12 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="TLSCertificatesClient"><a class="viewcode-back" href="../../tls_certificates.html#ngrok.services.TLSCertificatesClient">[docs]</a><span class="k">class</span> <span class="nc">TLSCertificatesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""TLS Certificates are pairs of x509 certificates and their matching private</span>
|
||||
<span class="sd"> key that can be used to terminate TLS traffic. TLS certificates are unused</span>
|
||||
<span class="sd"> until they are attached to a Domain. TLS Certificates may also be</span>
|
||||
<span class="sd"> provisioned by ngrok automatically for domains on which you have enabled</span>
|
||||
<span class="sd"> automated certificate provisioning."""</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>
|
||||
|
||||
@@ -3141,6 +3437,10 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="TunnelSessionsClient"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient">[docs]</a><span class="k">class</span> <span class="nc">TunnelSessionsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</span>
|
||||
<span class="sd"> sessions that are running and connected to the ngrok service. Each tunnel</span>
|
||||
<span class="sd"> session can include one or more Tunnels."""</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>
|
||||
|
||||
@@ -3233,6 +3533,9 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="TunnelsClient"><a class="viewcode-back" href="../../tunnels.html#ngrok.services.TunnelsClient">[docs]</a><span class="k">class</span> <span class="nc">TunnelsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""Tunnels provide endpoints to access services exposed by a running ngrok</span>
|
||||
<span class="sd"> agent tunnel session or an SSH reverse tunnel session."""</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>
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
Event Sources
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.event_sources` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: EventSourcesClient
|
||||
:undoc-members: EventSourcesClient
|
||||
@@ -0,0 +1,9 @@
|
||||
Event Subscriptions
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.event_subscriptions` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: EventSubscriptionsClient
|
||||
:undoc-members: EventSubscriptionsClient
|
||||
@@ -41,10 +41,10 @@ object. That's it!
|
||||
policy = ng.ip_policies.create(action="allow")
|
||||
for cidr in ["24.0.0.0/8", "12.0.0.0/8"]:
|
||||
ng.ip_policy_rules.create(cidr=cidr, ip_policy_id=policy.id)
|
||||
|
||||
|
||||
Transparent Paging
|
||||
------------------
|
||||
|
||||
Automatic Paging
|
||||
----------------
|
||||
|
||||
The ngrok API pages all list resources but this library abstracts that away
|
||||
from you. All response objects from any ``list()`` methods return an object that
|
||||
@@ -120,13 +120,15 @@ API Reference
|
||||
api_keys
|
||||
certificate_authorities
|
||||
credentials
|
||||
endpoint_configurations
|
||||
event_streams
|
||||
event_destinations
|
||||
event_subscriptions
|
||||
event_sources
|
||||
ip_policies
|
||||
ip_policy_rules
|
||||
ip_restrictions
|
||||
ip_whitelist
|
||||
endpoint_configurations
|
||||
endpoint_logging_module
|
||||
endpoint_circuit_breaker_module
|
||||
endpoint_compression_module
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,9 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.AbuseReportsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">AbuseReportsClient</span></code><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#AbuseReportsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.AbuseReportsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>Abuse Reports allow you to submit take-down requests for URLs hosted by
|
||||
ngrok that violate ngrok’s terms of service.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.AbuseReportsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urls</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#AbuseReportsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.AbuseReportsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a new abuse report which will be reviewed by our system and abuse response team. This API is only available to authorized accounts. Contact <a class="reference external" href="mailto:abuse%40ngrok.com">abuse<span>@</span>ngrok<span>.</span>com</a> to request access</p>
|
||||
|
||||
+9
-2
@@ -119,13 +119,15 @@
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,12 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.APIKeysClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">APIKeysClient</span></code><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#APIKeysClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.APIKeysClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>API Keys are used to authenticate to the <cite>ngrok
|
||||
API</cite> <<a class="reference external" href="https://ngrok.com/docs/api#authentication">https://ngrok.com/docs/api#authentication</a>>`_. You may use the API itself
|
||||
to provision and manage API Keys but you’ll need to provision your first API
|
||||
key from the <cite>API Keys page</cite> <<a class="reference external" href="https://dashboard.ngrok.com/api/keys">https://dashboard.ngrok.com/api/keys</a>>`_ on your
|
||||
ngrok.com dashboard.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.APIKeysClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#APIKeysClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.APIKeysClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new API key. The generated API key can be used to authenticate to the ngrok API.</p>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,12 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.CertificateAuthoritiesClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">CertificateAuthoritiesClient</span></code><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#CertificateAuthoritiesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CertificateAuthoritiesClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>Certificate Authorities are x509 certificates that are used to sign other
|
||||
x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
||||
to verify that the TLS certificate presented by a client has been signed by
|
||||
this CA. Certificate Authorities are used only for mTLS validation only and
|
||||
thus a private key is not included in the resource.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.CertificateAuthoritiesClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ca_pem</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#CertificateAuthoritiesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CertificateAuthoritiesClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Upload a new Certificate Authority</p>
|
||||
|
||||
+98
-20
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -186,7 +188,9 @@ Client object:</p>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.Client.abuse_reports">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">abuse_reports</span></code><a class="headerlink" href="#ngrok.Client.abuse_reports" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>Abuse Reports allow you to submit take-down requests for URLs hosted by
|
||||
ngrok that violate ngrok’s terms of service.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="abuse_reports.html#ngrok.services.AbuseReportsClient" title="ngrok.services.AbuseReportsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbuseReportsClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -195,7 +199,12 @@ Client object:</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.api_keys">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">api_keys</span></code><a class="headerlink" href="#ngrok.Client.api_keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>API Keys are used to authenticate to the <cite>ngrok
|
||||
API</cite> <<a class="reference external" href="https://ngrok.com/docs/api#authentication">https://ngrok.com/docs/api#authentication</a>>`_. You may use the API itself
|
||||
to provision and manage API Keys but you’ll need to provision your first API
|
||||
key from the <cite>API Keys page</cite> <<a class="reference external" href="https://dashboard.ngrok.com/api/keys">https://dashboard.ngrok.com/api/keys</a>>`_ on your
|
||||
ngrok.com dashboard.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="api_keys.html#ngrok.services.APIKeysClient" title="ngrok.services.APIKeysClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKeysClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -204,7 +213,12 @@ Client object:</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.certificate_authorities">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate_authorities</span></code><a class="headerlink" href="#ngrok.Client.certificate_authorities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>Certificate Authorities are x509 certificates that are used to sign other
|
||||
x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
||||
to verify that the TLS certificate presented by a client has been signed by
|
||||
this CA. Certificate Authorities are used only for mTLS validation only and
|
||||
thus a private key is not included in the resource.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient" title="ngrok.services.CertificateAuthoritiesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthoritiesClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -213,7 +227,11 @@ Client object:</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.credentials">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">credentials</span></code><a class="headerlink" href="#ngrok.Client.credentials" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
||||
agent to connect the ngrok service as your account. They are installed with
|
||||
the <code class="docutils literal notranslate"><span class="pre">ngrok</span> <span class="pre">authtoken</span></code> command or by specifying it in the <code class="docutils literal notranslate"><span class="pre">ngrok.yml</span></code>
|
||||
configuration file with the <code class="docutils literal notranslate"><span class="pre">authtoken</span></code> property.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="credentials.html#ngrok.services.CredentialsClient" title="ngrok.services.CredentialsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialsClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -222,8 +240,9 @@ Client object:</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.endpoint_configurations">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">endpoint_configurations</span></code><a class="headerlink" href="#ngrok.Client.endpoint_configurations" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Endpoint Configuration managementAn <cite>Endpoint Configuration</cite> <<a class="reference external" href="https://ngrok.com/docs/ngrok-link#api-endpoint-configurations">https://ngrok.com/docs/ngrok-link#api-endpoint-configurations</a>>`_ describes
|
||||
a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!*</p>
|
||||
<dd><p>Endpoint Configurations are a reusable group of modules that encapsulate how
|
||||
traffic to a domain or address is handled. Endpoint configurations are only
|
||||
applied to Domains and TCP Addresses they have been attached to.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient" title="ngrok.services.EndpointConfigurationsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfigurationsClient</span></code></a></p>
|
||||
@@ -240,6 +259,15 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.event_sources">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_sources</span></code><a class="headerlink" href="#ngrok.Client.event_sources" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="event_sources.html#ngrok.services.EventSourcesClient" title="ngrok.services.EventSourcesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSourcesClient</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.event_streams">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_streams</span></code><a class="headerlink" href="#ngrok.Client.event_streams" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
@@ -249,9 +277,22 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.event_subscriptions">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_subscriptions</span></code><a class="headerlink" href="#ngrok.Client.event_subscriptions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="event_subscriptions.html#ngrok.services.EventSubscriptionsClient" title="ngrok.services.EventSubscriptionsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSubscriptionsClient</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.ip_policies">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_policies</span></code><a class="headerlink" href="#ngrok.Client.ip_policies" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>IP Policies are reusable groups of CIDR ranges with an <code class="docutils literal notranslate"><span class="pre">allow</span></code> or <code class="docutils literal notranslate"><span class="pre">deny</span></code>
|
||||
action. They can be attached to endpoints via the Endpoint Configuration IP
|
||||
Policy module. They can also be used with IP Restrictions to control source
|
||||
IP ranges that can start tunnel sessions and connect to the API and dashboard.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="ip_policies.html#ngrok.services.IPPoliciesClient" title="ngrok.services.IPPoliciesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPoliciesClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -260,7 +301,9 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.ip_policy_rules">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_policy_rules</span></code><a class="headerlink" href="#ngrok.Client.ip_policy_rules" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
|
||||
make up an IP Policy.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="ip_policy_rules.html#ngrok.services.IPPolicyRulesClient" title="ngrok.services.IPPolicyRulesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRulesClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -269,7 +312,13 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.ip_restrictions">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_restrictions</span></code><a class="headerlink" href="#ngrok.Client.ip_restrictions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>An IP restriction is a restriction placed on the CIDRs that are allowed to
|
||||
initate traffic to a specific aspect of your ngrok account. An IP
|
||||
restriction has a type which defines the ingress it applies to. IP
|
||||
restrictions can be used to enforce the source IPs that can make API
|
||||
requests, log in to the dashboard, start ngrok agents, and connect to your
|
||||
public-facing endpoints.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="ip_restrictions.html#ngrok.services.IPRestrictionsClient" title="ngrok.services.IPRestrictionsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestrictionsClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -278,7 +327,9 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.ip_whitelist">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_whitelist</span></code><a class="headerlink" href="#ngrok.Client.ip_whitelist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction
|
||||
with an <code class="docutils literal notranslate"><span class="pre">endpoints</span></code> type instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="ip_whitelist.html#ngrok.services.IPWhitelistClient" title="ngrok.services.IPWhitelistClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -291,7 +342,10 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.reserved_addrs">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">reserved_addrs</span></code><a class="headerlink" href="#ngrok.Client.reserved_addrs" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>Reserved Addresses are TCP addresses that can be used to listen for traffic.
|
||||
TCP address hostnames and ports are assigned by ngrok, they cannot be
|
||||
chosen.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="reserved_addrs.html#ngrok.services.ReservedAddrsClient" title="ngrok.services.ReservedAddrsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddrsClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -300,7 +354,11 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.reserved_domains">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">reserved_domains</span></code><a class="headerlink" href="#ngrok.Client.reserved_domains" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>Reserved Domains are hostnames that you can listen for traffic on. Domains
|
||||
can be used to listen for http, https or tls traffic. You may use a domain
|
||||
that you own by creating a CNAME record specified in the returned resource.
|
||||
This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="reserved_domains.html#ngrok.services.ReservedDomainsClient" title="ngrok.services.ReservedDomainsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainsClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -309,7 +367,9 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.ssh_certificate_authorities">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_certificate_authorities</span></code><a class="headerlink" href="#ngrok.Client.ssh_certificate_authorities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
||||
key that can be used to sign other SSH host and user certificates.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient" title="ngrok.services.SSHCertificateAuthoritiesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthoritiesClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -318,7 +378,9 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.ssh_credentials">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_credentials</span></code><a class="headerlink" href="#ngrok.Client.ssh_credentials" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>SSH Credentials are SSH public keys that can be used to start SSH tunnels
|
||||
via the ngrok SSH tunnel gateway.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="ssh_credentials.html#ngrok.services.SSHCredentialsClient" title="ngrok.services.SSHCredentialsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredentialsClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -327,7 +389,10 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.ssh_host_certificates">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_host_certificates</span></code><a class="headerlink" href="#ngrok.Client.ssh_host_certificates" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>SSH Host Certificates along with the corresponding private key allows an SSH
|
||||
server to assert its authenticity to connecting SSH clients who trust the
|
||||
SSH Certificate Authority that was used to sign the certificate.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient" title="ngrok.services.SSHHostCertificatesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificatesClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -336,7 +401,10 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.ssh_user_certificates">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_user_certificates</span></code><a class="headerlink" href="#ngrok.Client.ssh_user_certificates" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>SSH User Certificates are presented by SSH clients when connecting to an SSH
|
||||
server to authenticate their connection. The SSH server must trust the SSH
|
||||
Certificate Authority used to sign the certificate.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient" title="ngrok.services.SSHUserCertificatesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificatesClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -345,7 +413,12 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.tls_certificates">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tls_certificates</span></code><a class="headerlink" href="#ngrok.Client.tls_certificates" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>TLS Certificates are pairs of x509 certificates and their matching private
|
||||
key that can be used to terminate TLS traffic. TLS certificates are unused
|
||||
until they are attached to a Domain. TLS Certificates may also be
|
||||
provisioned by ngrok automatically for domains on which you have enabled
|
||||
automated certificate provisioning.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="tls_certificates.html#ngrok.services.TLSCertificatesClient" title="ngrok.services.TLSCertificatesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificatesClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -354,7 +427,10 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.tunnel_sessions">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tunnel_sessions</span></code><a class="headerlink" href="#ngrok.Client.tunnel_sessions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>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.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="tunnel_sessions.html#ngrok.services.TunnelSessionsClient" title="ngrok.services.TunnelSessionsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelSessionsClient</span></code></a></p>
|
||||
</dd>
|
||||
@@ -363,7 +439,9 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.tunnels">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tunnels</span></code><a class="headerlink" href="#ngrok.Client.tunnels" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dd><p>Tunnels provide endpoints to access services exposed by a running ngrok
|
||||
agent tunnel session or an SSH reverse tunnel session.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="tunnels.html#ngrok.services.TunnelsClient" title="ngrok.services.TunnelsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelsClient</span></code></a></p>
|
||||
</dd>
|
||||
|
||||
+11
-5
@@ -2,7 +2,7 @@
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Streams" href="event_streams.html" /><link rel="prev" title="Certificate Authorities" href="certificate_authorities.html" />
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Endpoint Configurations" href="endpoint_configurations.html" /><link rel="prev" title="Certificate Authorities" href="certificate_authorities.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Tunnel Credentials - ngrok-api documentation</title>
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,11 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.CredentialsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">CredentialsClient</span></code><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#CredentialsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CredentialsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
||||
agent to connect the ngrok service as your account. They are installed with
|
||||
the <code class="docutils literal notranslate"><span class="pre">ngrok</span> <span class="pre">authtoken</span></code> command or by specifying it in the <code class="docutils literal notranslate"><span class="pre">ngrok.yml</span></code>
|
||||
configuration file with the <code class="docutils literal notranslate"><span class="pre">authtoken</span></code> property.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.CredentialsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><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">acl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#CredentialsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CredentialsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.</p>
|
||||
@@ -262,12 +268,12 @@
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="event_streams.html">
|
||||
<a class="next-page" href="endpoint_configurations.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Event Streams</div>
|
||||
<div class="title">Endpoint Configurations</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
+199
-3
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -1779,6 +1781,16 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointSAML.nameid_format">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">nameid_format</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.nameid_format" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of <code class="docutils literal notranslate"><span class="pre">urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</span></code> will be used. A subset of the allowed values enumerated by the SAML specification are supported.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EndpointSAML.options_passthrough">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">options_passthrough</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.options_passthrough" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.</p>
|
||||
@@ -1893,6 +1905,16 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointSAMLMutate.nameid_format">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">nameid_format</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.nameid_format" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of <code class="docutils literal notranslate"><span class="pre">urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</span></code> will be used. A subset of the allowed values enumerated by the SAML specification are supported.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EndpointSAMLMutate.options_passthrough">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">options_passthrough</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.options_passthrough" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.</p>
|
||||
@@ -1953,7 +1975,7 @@
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointWebhookValidation.provider">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">provider</span></code><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: <code class="docutils literal notranslate"><span class="pre">SLACK</span></code>, <code class="docutils literal notranslate"><span class="pre">SNS</span></code>, <code class="docutils literal notranslate"><span class="pre">STRIPE</span></code>, <code class="docutils literal notranslate"><span class="pre">GITHUB</span></code>, <code class="docutils literal notranslate"><span class="pre">TWILIO</span></code>, <code class="docutils literal notranslate"><span class="pre">SHOPIFY</span></code>, <code class="docutils literal notranslate"><span class="pre">GITLAB</span></code>, <code class="docutils literal notranslate"><span class="pre">INTERCOM</span></code>.</p>
|
||||
<dd><p>a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: <code class="docutils literal notranslate"><span class="pre">SLACK</span></code>, <code class="docutils literal notranslate"><span class="pre">SNS</span></code>, <code class="docutils literal notranslate"><span class="pre">STRIPE</span></code>, <code class="docutils literal notranslate"><span class="pre">GITHUB</span></code>, <code class="docutils literal notranslate"><span class="pre">TWILIO</span></code>, <code class="docutils literal notranslate"><span class="pre">SHOPIFY</span></code>, <code class="docutils literal notranslate"><span class="pre">GITLAB</span></code>, <code class="docutils literal notranslate"><span class="pre">INTERCOM</span></code>, <code class="docutils literal notranslate"><span class="pre">SENDGRID</span></code>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
@@ -2084,6 +2106,68 @@
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.EventSource">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSource</span></code><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#EventSource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSource" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSource.type">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#ngrok.datatypes.EventSource.type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type of event for which an event subscription will trigger</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventSource.uri">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSource.uri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URI of the Event Source API resource.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventSourceList">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSourceList</span></code><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#EventSourceList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSourceList" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSourceList.sources">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">sources</span></code><a class="headerlink" href="#ngrok.datatypes.EventSourceList.sources" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The list of all Event Sources for an Event Subscription</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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.EventSource" title="ngrok.datatypes.EventSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSource</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSourceList.uri">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSourceList.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</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 id="ngrok.datatypes.EventSourceReplace">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSourceReplace</span></code><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#EventSourceReplace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSourceReplace" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSourceReplace.type">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#ngrok.datatypes.EventSourceReplace.type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type of event for which an event subscription will trigger</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventStream">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventStream</span></code><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#EventStream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventStream" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
@@ -2220,6 +2304,118 @@
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.EventSubscription">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSubscription</span></code><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#EventSubscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSubscription" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSubscription.created_at">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.created_at" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>When the Event Subscription was created (RFC 3339 format).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventSubscription.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventSubscription.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSubscription.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSubscription.description">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventSubscription.destinations">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">destinations</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.destinations" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destinations to which these events will be sent</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSubscription.id">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Unique identifier for this Event Subscription.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventSubscription.metadata">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventSubscription.sources">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">sources</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.sources" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sources containing the types for which this event subscription will trigger</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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.EventSource" title="ngrok.datatypes.EventSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSource</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSubscription.uri">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.uri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URI of the Event Subscription API resource.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventSubscriptionList">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSubscriptionList</span></code><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#EventSubscriptionList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSubscriptionList" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSubscriptionList.event_subscriptions">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_subscriptions</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscriptionList.event_subscriptions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The list of all Event Subscriptions on this account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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.EventSubscription" title="ngrok.datatypes.EventSubscription"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSubscription</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EventSubscriptionList.next_page_uri">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscriptionList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URI of next page, or null if there is no next page.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventSubscriptionList.uri">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscriptionList.uri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URI of the Event Subscriptions list API resource.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</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 id="ngrok.datatypes.EventTarget">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventTarget</span></code><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#EventTarget"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventTarget" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
@@ -2577,7 +2773,7 @@
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.IPRestriction.enforced">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enforced</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestriction.enforced" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>true if the IP restriction will be enforce. if false, only warnings will be issued</p>
|
||||
<dd><p>true if the IP restriction will be enforced. if false, only warnings will be issued</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Compression Module</a></li>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Logging Module" href="endpoint_logging_module.html" /><link rel="prev" title="IP Whitelist" href="ip_whitelist.html" />
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Streams" href="event_streams.html" /><link rel="prev" title="Tunnel Credentials" href="credentials.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Endpoint Configurations - ngrok-api documentation</title>
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="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="#">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,8 +170,9 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.EndpointConfigurationsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">EndpointConfigurationsClient</span></code><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#EndpointConfigurationsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointConfigurationsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Endpoint Configuration managementAn <cite>Endpoint Configuration</cite> <<a class="reference external" href="https://ngrok.com/docs/ngrok-link#api-endpoint-configurations">https://ngrok.com/docs/ngrok-link#api-endpoint-configurations</a>>`_ describes
|
||||
a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!*</p>
|
||||
<dd><p>Endpoint Configurations are a reusable group of modules that encapsulate how
|
||||
traffic to a domain or address is handled. Endpoint configurations are only
|
||||
applied to Domains and TCP Addresses they have been attached to.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.EndpointConfigurationsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">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">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">ip_policy</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">webhook_validation</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">logging</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EndpointConfigurationsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointConfigurationsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
@@ -287,23 +290,23 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="endpoint_logging_module.html">
|
||||
<a class="next-page" href="event_streams.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Logging Module</div>
|
||||
<div class="title">Event Streams</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="ip_whitelist.html">
|
||||
<a class="prev-page" href="credentials.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">IP Whitelist</div>
|
||||
<div class="title">Tunnel Credentials</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Circuit Breaker Module" href="endpoint_circuit_breaker_module.html" /><link rel="prev" title="Endpoint Configurations" href="endpoint_configurations.html" />
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Circuit Breaker Module" href="endpoint_circuit_breaker_module.html" /><link rel="prev" title="IP Whitelist" href="ip_whitelist.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Logging Module - ngrok-api documentation</title>
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -227,14 +229,14 @@
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="endpoint_configurations.html">
|
||||
<a class="prev-page" href="ip_whitelist.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Endpoint Configurations</div>
|
||||
<div class="title">IP Whitelist</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
+3
-1
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="IP Policies" href="ip_policies.html" /><link rel="prev" title="Event Streams" href="event_streams.html" />
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Subscriptions" href="event_subscriptions.html" /><link rel="prev" title="Event Streams" href="event_streams.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Event Destinations - ngrok-api documentation</title>
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1 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>
|
||||
<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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -264,12 +266,12 @@
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="ip_policies.html">
|
||||
<a class="next-page" href="event_subscriptions.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">IP Policies</div>
|
||||
<div class="title">Event Subscriptions</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@@ -0,0 +1,317 @@
|
||||
<!doctype html>
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="IP Policies" href="ip_policies.html" /><link rel="prev" title="Event Subscriptions" href="event_subscriptions.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Event Sources - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" href="_static/styles/furo.css?digest=59ab60ac09ea94ccfe6deddff6d715cce948a6fc">
|
||||
<link rel="stylesheet" href="_static/pygments.css">
|
||||
<link media="(prefers-color-scheme: dark)" rel="stylesheet" href="_static/pygments_dark.css">
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
:root {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/* For allowing end-user-specific overrides */
|
||||
.override-light {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
.override-dark {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
</style><link rel="stylesheet" href="_static/styles/furo-extensions.css?digest=d391b54134226e4196576da3bdb6dddb7e05ba2b"></head>
|
||||
<body dir="">
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke-width="1.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path stroke="none" d="M0 0h24v24H0z"/>
|
||||
<line x1="4" y1="6" x2="20" y2="6" />
|
||||
<line x1="10" y1="12" x2="20" y2="12" />
|
||||
<line x1="6" y1="18" x2="20" y2="18" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="feather 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" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="feather feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</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"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<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">
|
||||
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
||||
<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">
|
||||
<input class="sidebar-search" placeholder=Search name="q">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption"><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"><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="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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 current current-page"><a class="current reference internal" href="#">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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_tls_termination_module.html">TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_ip_policy_module.html">IP Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_request_headers_module.html">Request Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_response_headers_module.html">Response Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_o_auth_module.html">OAuth Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_saml_module.html">SAML Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_oidc_module.html">OIDC Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<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="tunnel_sessions.html">Tunnel Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<main class="main">
|
||||
<div class="content">
|
||||
<article role="main">
|
||||
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
<div class="section" id="event-sources">
|
||||
<h1>Event Sources<a class="headerlink" href="#event-sources" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<a class="reference internal" href="client.html#ngrok.Client.event_sources" title="ngrok.Client.event_sources"><code class="xref py py-attr docutils literal notranslate"><span class="pre">event_sources</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 id="ngrok.services.EventSourcesClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">EventSourcesClient</span></code><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#EventSourcesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSourcesClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.services.EventSourcesClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EventSourcesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSourcesClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add an additional type for which this event subscription will trigger</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>subscription_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unique identifier for the Event Subscription that this Event Source is attached to.</p></li>
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Type of event for which an event subscription will trigger</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-sources-create">https://ngrok.com/docs/api#api-event-sources-create</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSource" title="ngrok.datatypes.EventSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSource</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.EventSourcesClient.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EventSourcesClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSourcesClient.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove a type for which this event subscription will trigger</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>subscription_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unique identifier for the Event Subscription that this Event Source is attached to.</p></li>
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Type of event for which an event subscription will trigger</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-sources-delete">https://ngrok.com/docs/api#api-event-sources-delete</a></p>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.EventSourcesClient.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EventSourcesClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSourcesClient.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the details for a given type that triggers for the given event subscription</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>subscription_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unique identifier for the Event Subscription that this Event Source is attached to.</p></li>
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Type of event for which an event subscription will trigger</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-sources-get">https://ngrok.com/docs/api#api-event-sources-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSource" title="ngrok.datatypes.EventSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSource</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.EventSourcesClient.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EventSourcesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSourcesClient.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List the types for which this event subscription will trigger</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>subscription_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unique identifier for the Event Subscription that this Event Source is attached to.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-sources-list">https://ngrok.com/docs/api#api-event-sources-list</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSourceList" title="ngrok.datatypes.EventSourceList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSourceList</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.EventSourcesClient.update">
|
||||
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EventSourcesClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSourcesClient.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Update the type for which this event subscription will trigger</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>subscription_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unique identifier for the Event Subscription that this Event Source is attached to.</p></li>
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Type of event for which an event subscription will trigger</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-sources-update">https://ngrok.com/docs/api#api-event-sources-update</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSource" title="ngrok.datatypes.EventSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSource</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
</div>
|
||||
|
||||
</article>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="ip_policies.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">IP Policies</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="event_subscriptions.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Event Subscriptions</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="related-information">
|
||||
Copyright © 2021, ngrok Inc.
|
||||
|
|
||||
Built 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 theme</a>.
|
||||
|
|
||||
<a class="muted-link" href="_sources/event_sources.rst.txt"
|
||||
rel="nofollow">
|
||||
Show Source
|
||||
</a>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer no-toc">
|
||||
|
||||
|
||||
|
||||
</aside>
|
||||
</main>
|
||||
</div>
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/scripts/main.js?digest=e931d09b2a40c1bb82b542effe772014573baf67"></script></body>
|
||||
</html>
|
||||
@@ -2,7 +2,7 @@
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Destinations" href="event_destinations.html" /><link rel="prev" title="Tunnel Credentials" href="credentials.html" />
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Destinations" href="event_destinations.html" /><link rel="prev" title="Endpoint Configurations" href="endpoint_configurations.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Event Streams - ngrok-api documentation</title>
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Event Streams</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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -276,14 +278,14 @@
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="credentials.html">
|
||||
<a class="prev-page" href="endpoint_configurations.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Tunnel Credentials</div>
|
||||
<div class="title">Endpoint Configurations</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -0,0 +1,319 @@
|
||||
<!doctype html>
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Sources" href="event_sources.html" /><link rel="prev" title="Event Destinations" href="event_destinations.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Event Subscriptions - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" href="_static/styles/furo.css?digest=59ab60ac09ea94ccfe6deddff6d715cce948a6fc">
|
||||
<link rel="stylesheet" href="_static/pygments.css">
|
||||
<link media="(prefers-color-scheme: dark)" rel="stylesheet" href="_static/pygments_dark.css">
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
:root {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/* For allowing end-user-specific overrides */
|
||||
.override-light {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
.override-dark {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
</style><link rel="stylesheet" href="_static/styles/furo-extensions.css?digest=d391b54134226e4196576da3bdb6dddb7e05ba2b"></head>
|
||||
<body dir="">
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke-width="1.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path stroke="none" d="M0 0h24v24H0z"/>
|
||||
<line x1="4" y1="6" x2="20" y2="6" />
|
||||
<line x1="10" y1="12" x2="20" y2="12" />
|
||||
<line x1="6" y1="18" x2="20" y2="18" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="feather 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" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="feather feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</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"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<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">
|
||||
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
||||
<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">
|
||||
<input class="sidebar-search" placeholder=Search name="q">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption"><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"><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="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_tls_termination_module.html">TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_ip_policy_module.html">IP Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_request_headers_module.html">Request Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_response_headers_module.html">Response Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_o_auth_module.html">OAuth Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_saml_module.html">SAML Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_oidc_module.html">OIDC Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<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="tunnel_sessions.html">Tunnel Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<main class="main">
|
||||
<div class="content">
|
||||
<article role="main">
|
||||
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
<div class="section" id="event-subscriptions">
|
||||
<h1>Event Subscriptions<a class="headerlink" href="#event-subscriptions" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<a class="reference internal" href="client.html#ngrok.Client.event_subscriptions" title="ngrok.Client.event_subscriptions"><code class="xref py py-attr docutils literal notranslate"><span class="pre">event_subscriptions</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 id="ngrok.services.EventSubscriptionsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">EventSubscriptionsClient</span></code><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#EventSubscriptionsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSubscriptionsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.services.EventSubscriptionsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><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">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">sources</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">destination_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EventSubscriptionsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSubscriptionsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create an Event Subscription.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<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 Stream. Event Streams are required to have at least one Event Destination.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-subscriptions-create">https://ngrok.com/docs/api#api-event-subscriptions-create</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSubscription" title="ngrok.datatypes.EventSubscription"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSubscription</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.EventSubscriptionsClient.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><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#EventSubscriptionsClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSubscriptionsClient.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete an Event Subscription.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</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-event-subscriptions-delete">https://ngrok.com/docs/api#api-event-subscriptions-delete</a></p>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.EventSubscriptionsClient.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><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#EventSubscriptionsClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSubscriptionsClient.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get an Event Subscription by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</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-event-subscriptions-get">https://ngrok.com/docs/api#api-event-subscriptions-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSubscription" title="ngrok.datatypes.EventSubscription"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSubscription</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.EventSubscriptionsClient.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><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#EventSubscriptionsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSubscriptionsClient.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List this Account’s Event Subscriptions.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</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>]) – </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>]) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-subscriptions-list">https://ngrok.com/docs/api#api-event-subscriptions-list</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSubscriptionList" title="ngrok.datatypes.EventSubscriptionList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSubscriptionList</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.EventSubscriptionsClient.update">
|
||||
<code class="sig-name descname"><span class="pre">update</span></code><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">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">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">sources</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">destination_ids</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#EventSubscriptionsClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventSubscriptionsClient.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Update an Event Subscription.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</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>]) – 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>]) – 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>]]) – 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>]]) – A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-subscriptions-update">https://ngrok.com/docs/api#api-event-subscriptions-update</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventSubscription" title="ngrok.datatypes.EventSubscription"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSubscription</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
</div>
|
||||
|
||||
</article>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="event_sources.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Event Sources</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="event_destinations.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Event Destinations</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="related-information">
|
||||
Copyright © 2021, ngrok Inc.
|
||||
|
|
||||
Built 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 theme</a>.
|
||||
|
|
||||
<a class="muted-link" href="_sources/event_subscriptions.rst.txt"
|
||||
rel="nofollow">
|
||||
Show Source
|
||||
</a>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer no-toc">
|
||||
|
||||
|
||||
|
||||
</aside>
|
||||
</main>
|
||||
</div>
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/scripts/main.js?digest=e931d09b2a40c1bb82b542effe772014573baf67"></script></body>
|
||||
</html>
|
||||
+91
-9
@@ -118,13 +118,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -339,8 +341,12 @@
|
||||
<li><a href="endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.create">(ngrok.services.EndpointConfigurationsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_destinations.html#ngrok.services.EventDestinationsClient.create">(ngrok.services.EventDestinationsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_sources.html#ngrok.services.EventSourcesClient.create">(ngrok.services.EventSourcesClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_streams.html#ngrok.services.EventStreamsClient.create">(ngrok.services.EventStreamsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_subscriptions.html#ngrok.services.EventSubscriptionsClient.create">(ngrok.services.EventSubscriptionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ip_policies.html#ngrok.services.IPPoliciesClient.create">(ngrok.services.IPPoliciesClient method)</a>
|
||||
</li>
|
||||
@@ -381,6 +387,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestination.created_at">(ngrok.datatypes.EventDestination property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStream.created_at">(ngrok.datatypes.EventStream property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription.created_at">(ngrok.datatypes.EventSubscription property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicy.created_at">(ngrok.datatypes.IPPolicy property)</a>
|
||||
</li>
|
||||
@@ -443,6 +451,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestination.delete">(ngrok.datatypes.EventDestination method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStream.delete">(ngrok.datatypes.EventStream method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription.delete">(ngrok.datatypes.EventSubscription method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicy.delete">(ngrok.datatypes.IPPolicy method)</a>
|
||||
</li>
|
||||
@@ -499,8 +509,12 @@
|
||||
<li><a href="endpoint_webhook_validation_module.html#ngrok.services.EndpointWebhookValidationModuleClient.delete">(ngrok.services.EndpointWebhookValidationModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_destinations.html#ngrok.services.EventDestinationsClient.delete">(ngrok.services.EventDestinationsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_sources.html#ngrok.services.EventSourcesClient.delete">(ngrok.services.EventSourcesClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_streams.html#ngrok.services.EventStreamsClient.delete">(ngrok.services.EventStreamsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_subscriptions.html#ngrok.services.EventSubscriptionsClient.delete">(ngrok.services.EventSubscriptionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ip_policies.html#ngrok.services.IPPoliciesClient.delete">(ngrok.services.IPPoliciesClient method)</a>
|
||||
</li>
|
||||
@@ -551,6 +565,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestination.description">(ngrok.datatypes.EventDestination property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStream.description">(ngrok.datatypes.EventStream property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription.description">(ngrok.datatypes.EventSubscription property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicy.description">(ngrok.datatypes.IPPolicy property)</a>
|
||||
</li>
|
||||
@@ -576,6 +592,8 @@
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStream.destination_ids">destination_ids() (ngrok.datatypes.EventStream property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription.destinations">destinations() (ngrok.datatypes.EventSubscription property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TLSCertificateSANs.dns_names">dns_names() (ngrok.datatypes.TLSCertificateSANs property)</a>
|
||||
</li>
|
||||
@@ -685,8 +703,6 @@
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuth">EndpointOAuth (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook">EndpointOAuthFacebook (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitHub">EndpointOAuthGitHub (class in ngrok.datatypes)</a>
|
||||
@@ -697,6 +713,8 @@
|
||||
</li>
|
||||
<li><a href="endpoint_o_auth_module.html#ngrok.services.EndpointOAuthModuleClient">EndpointOAuthModuleClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthProvider">EndpointOAuthProvider (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOIDC">EndpointOIDC (class in ngrok.datatypes)</a>
|
||||
@@ -741,6 +759,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestinationList.event_destinations">(ngrok.datatypes.EventDestinationList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="client.html#ngrok.Client.event_sources">event_sources() (ngrok.Client property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointLoggingMutate.event_stream_ids">event_stream_ids() (ngrok.datatypes.EndpointLoggingMutate property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.event_streams">event_streams() (ngrok.Client property)</a>
|
||||
@@ -749,6 +769,12 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointLogging.event_streams">(ngrok.datatypes.EndpointLogging property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStreamList.event_streams">(ngrok.datatypes.EventStreamList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="client.html#ngrok.Client.event_subscriptions">event_subscriptions() (ngrok.Client property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscriptionList.event_subscriptions">(ngrok.datatypes.EventSubscriptionList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStream.event_type">event_type() (ngrok.datatypes.EventStream property)</a>
|
||||
@@ -758,12 +784,26 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestinationList">EventDestinationList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="event_destinations.html#ngrok.services.EventDestinationsClient">EventDestinationsClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSource">EventSource (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSourceList">EventSourceList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSourceReplace">EventSourceReplace (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="event_sources.html#ngrok.services.EventSourcesClient">EventSourcesClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStream">EventStream (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStreamList">EventStreamList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="event_streams.html#ngrok.services.EventStreamsClient">EventStreamsClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription">EventSubscription (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscriptionList">EventSubscriptionList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="event_subscriptions.html#ngrok.services.EventSubscriptionsClient">EventSubscriptionsClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventTarget">EventTarget (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
@@ -849,8 +889,12 @@
|
||||
<li><a href="endpoint_webhook_validation_module.html#ngrok.services.EndpointWebhookValidationModuleClient.get">(ngrok.services.EndpointWebhookValidationModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_destinations.html#ngrok.services.EventDestinationsClient.get">(ngrok.services.EventDestinationsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_sources.html#ngrok.services.EventSourcesClient.get">(ngrok.services.EventSourcesClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_streams.html#ngrok.services.EventStreamsClient.get">(ngrok.services.EventStreamsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_subscriptions.html#ngrok.services.EventSubscriptionsClient.get">(ngrok.services.EventSubscriptionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ip_policies.html#ngrok.services.IPPoliciesClient.get">(ngrok.services.IPPoliciesClient method)</a>
|
||||
</li>
|
||||
@@ -923,6 +967,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestination.id">(ngrok.datatypes.EventDestination property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStream.id">(ngrok.datatypes.EventStream property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription.id">(ngrok.datatypes.EventSubscription property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicy.id">(ngrok.datatypes.IPPolicy property)</a>
|
||||
</li>
|
||||
@@ -1085,8 +1131,12 @@
|
||||
<li><a href="endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.list">(ngrok.services.EndpointConfigurationsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_destinations.html#ngrok.services.EventDestinationsClient.list">(ngrok.services.EventDestinationsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_sources.html#ngrok.services.EventSourcesClient.list">(ngrok.services.EventSourcesClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_streams.html#ngrok.services.EventStreamsClient.list">(ngrok.services.EventStreamsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_subscriptions.html#ngrok.services.EventSubscriptionsClient.list">(ngrok.services.EventSubscriptionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ip_policies.html#ngrok.services.IPPoliciesClient.list">(ngrok.services.IPPoliciesClient method)</a>
|
||||
</li>
|
||||
@@ -1153,6 +1203,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestination.metadata">(ngrok.datatypes.EventDestination property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStream.metadata">(ngrok.datatypes.EventStream property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription.metadata">(ngrok.datatypes.EventSubscription property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicy.metadata">(ngrok.datatypes.IPPolicy property)</a>
|
||||
</li>
|
||||
@@ -1197,7 +1249,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="api_keys.html#module-ngrok.services">[1]</a>, <a href="certificate_authorities.html#module-ngrok.services">[2]</a>, <a href="credentials.html#module-ngrok.services">[3]</a>, <a href="endpoint_circuit_breaker_module.html#module-ngrok.services">[4]</a>, <a href="endpoint_compression_module.html#module-ngrok.services">[5]</a>, <a href="endpoint_configurations.html#module-ngrok.services">[6]</a>, <a href="endpoint_ip_policy_module.html#module-ngrok.services">[7]</a>, <a href="endpoint_logging_module.html#module-ngrok.services">[8]</a>, <a href="endpoint_mutual_tls_module.html#module-ngrok.services">[9]</a>, <a href="endpoint_o_auth_module.html#module-ngrok.services">[10]</a>, <a href="endpoint_oidc_module.html#module-ngrok.services">[11]</a>, <a href="endpoint_request_headers_module.html#module-ngrok.services">[12]</a>, <a href="endpoint_response_headers_module.html#module-ngrok.services">[13]</a>, <a href="endpoint_saml_module.html#module-ngrok.services">[14]</a>, <a href="endpoint_tls_termination_module.html#module-ngrok.services">[15]</a>, <a href="endpoint_webhook_validation_module.html#module-ngrok.services">[16]</a>, <a href="event_destinations.html#module-ngrok.services">[17]</a>, <a href="event_streams.html#module-ngrok.services">[18]</a>, <a href="ip_policies.html#module-ngrok.services">[19]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[20]</a>, <a href="ip_restrictions.html#module-ngrok.services">[21]</a>, <a href="ip_whitelist.html#module-ngrok.services">[22]</a>, <a href="reserved_addrs.html#module-ngrok.services">[23]</a>, <a href="reserved_domains.html#module-ngrok.services">[24]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[25]</a>, <a href="ssh_credentials.html#module-ngrok.services">[26]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[27]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[28]</a>, <a href="tls_certificates.html#module-ngrok.services">[29]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[30]</a>, <a href="tunnels.html#module-ngrok.services">[31]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">ngrok.services</a>, <a href="api_keys.html#module-ngrok.services">[1]</a>, <a href="certificate_authorities.html#module-ngrok.services">[2]</a>, <a href="credentials.html#module-ngrok.services">[3]</a>, <a href="endpoint_circuit_breaker_module.html#module-ngrok.services">[4]</a>, <a href="endpoint_compression_module.html#module-ngrok.services">[5]</a>, <a href="endpoint_configurations.html#module-ngrok.services">[6]</a>, <a href="endpoint_ip_policy_module.html#module-ngrok.services">[7]</a>, <a href="endpoint_logging_module.html#module-ngrok.services">[8]</a>, <a href="endpoint_mutual_tls_module.html#module-ngrok.services">[9]</a>, <a href="endpoint_o_auth_module.html#module-ngrok.services">[10]</a>, <a href="endpoint_oidc_module.html#module-ngrok.services">[11]</a>, <a href="endpoint_request_headers_module.html#module-ngrok.services">[12]</a>, <a href="endpoint_response_headers_module.html#module-ngrok.services">[13]</a>, <a href="endpoint_saml_module.html#module-ngrok.services">[14]</a>, <a href="endpoint_tls_termination_module.html#module-ngrok.services">[15]</a>, <a href="endpoint_webhook_validation_module.html#module-ngrok.services">[16]</a>, <a href="event_destinations.html#module-ngrok.services">[17]</a>, <a href="event_sources.html#module-ngrok.services">[18]</a>, <a href="event_streams.html#module-ngrok.services">[19]</a>, <a href="event_subscriptions.html#module-ngrok.services">[20]</a>, <a href="ip_policies.html#module-ngrok.services">[21]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[22]</a>, <a href="ip_restrictions.html#module-ngrok.services">[23]</a>, <a href="ip_whitelist.html#module-ngrok.services">[24]</a>, <a href="reserved_addrs.html#module-ngrok.services">[25]</a>, <a href="reserved_domains.html#module-ngrok.services">[26]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[27]</a>, <a href="ssh_credentials.html#module-ngrok.services">[28]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[29]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[30]</a>, <a href="tls_certificates.html#module-ngrok.services">[31]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[32]</a>, <a href="tunnels.html#module-ngrok.services">[33]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomainCertJob.msg">msg() (ngrok.datatypes.ReservedDomainCertJob property)</a>
|
||||
@@ -1212,6 +1264,12 @@
|
||||
<h2>N</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.nameid_format">nameid_format() (ngrok.datatypes.EndpointSAML property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate.nameid_format">(ngrok.datatypes.EndpointSAMLMutate property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomainCertNSTarget.nameservers">nameservers() (ngrok.datatypes.ReservedDomainCertNSTarget property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKeyList.next_page_uri">next_page_uri() (ngrok.datatypes.APIKeyList property)</a>
|
||||
@@ -1226,6 +1284,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestinationList.next_page_uri">(ngrok.datatypes.EventDestinationList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStreamList.next_page_uri">(ngrok.datatypes.EventStreamList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscriptionList.next_page_uri">(ngrok.datatypes.EventSubscriptionList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicyList.next_page_uri">(ngrok.datatypes.IPPolicyList property)</a>
|
||||
</li>
|
||||
@@ -1274,7 +1334,7 @@
|
||||
ngrok.services
|
||||
|
||||
<ul>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="api_keys.html#module-ngrok.services">[1]</a>, <a href="certificate_authorities.html#module-ngrok.services">[2]</a>, <a href="credentials.html#module-ngrok.services">[3]</a>, <a href="endpoint_circuit_breaker_module.html#module-ngrok.services">[4]</a>, <a href="endpoint_compression_module.html#module-ngrok.services">[5]</a>, <a href="endpoint_configurations.html#module-ngrok.services">[6]</a>, <a href="endpoint_ip_policy_module.html#module-ngrok.services">[7]</a>, <a href="endpoint_logging_module.html#module-ngrok.services">[8]</a>, <a href="endpoint_mutual_tls_module.html#module-ngrok.services">[9]</a>, <a href="endpoint_o_auth_module.html#module-ngrok.services">[10]</a>, <a href="endpoint_oidc_module.html#module-ngrok.services">[11]</a>, <a href="endpoint_request_headers_module.html#module-ngrok.services">[12]</a>, <a href="endpoint_response_headers_module.html#module-ngrok.services">[13]</a>, <a href="endpoint_saml_module.html#module-ngrok.services">[14]</a>, <a href="endpoint_tls_termination_module.html#module-ngrok.services">[15]</a>, <a href="endpoint_webhook_validation_module.html#module-ngrok.services">[16]</a>, <a href="event_destinations.html#module-ngrok.services">[17]</a>, <a href="event_streams.html#module-ngrok.services">[18]</a>, <a href="ip_policies.html#module-ngrok.services">[19]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[20]</a>, <a href="ip_restrictions.html#module-ngrok.services">[21]</a>, <a href="ip_whitelist.html#module-ngrok.services">[22]</a>, <a href="reserved_addrs.html#module-ngrok.services">[23]</a>, <a href="reserved_domains.html#module-ngrok.services">[24]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[25]</a>, <a href="ssh_credentials.html#module-ngrok.services">[26]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[27]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[28]</a>, <a href="tls_certificates.html#module-ngrok.services">[29]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[30]</a>, <a href="tunnels.html#module-ngrok.services">[31]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="api_keys.html#module-ngrok.services">[1]</a>, <a href="certificate_authorities.html#module-ngrok.services">[2]</a>, <a href="credentials.html#module-ngrok.services">[3]</a>, <a href="endpoint_circuit_breaker_module.html#module-ngrok.services">[4]</a>, <a href="endpoint_compression_module.html#module-ngrok.services">[5]</a>, <a href="endpoint_configurations.html#module-ngrok.services">[6]</a>, <a href="endpoint_ip_policy_module.html#module-ngrok.services">[7]</a>, <a href="endpoint_logging_module.html#module-ngrok.services">[8]</a>, <a href="endpoint_mutual_tls_module.html#module-ngrok.services">[9]</a>, <a href="endpoint_o_auth_module.html#module-ngrok.services">[10]</a>, <a href="endpoint_oidc_module.html#module-ngrok.services">[11]</a>, <a href="endpoint_request_headers_module.html#module-ngrok.services">[12]</a>, <a href="endpoint_response_headers_module.html#module-ngrok.services">[13]</a>, <a href="endpoint_saml_module.html#module-ngrok.services">[14]</a>, <a href="endpoint_tls_termination_module.html#module-ngrok.services">[15]</a>, <a href="endpoint_webhook_validation_module.html#module-ngrok.services">[16]</a>, <a href="event_destinations.html#module-ngrok.services">[17]</a>, <a href="event_sources.html#module-ngrok.services">[18]</a>, <a href="event_streams.html#module-ngrok.services">[19]</a>, <a href="event_subscriptions.html#module-ngrok.services">[20]</a>, <a href="ip_policies.html#module-ngrok.services">[21]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[22]</a>, <a href="ip_restrictions.html#module-ngrok.services">[23]</a>, <a href="ip_whitelist.html#module-ngrok.services">[24]</a>, <a href="reserved_addrs.html#module-ngrok.services">[25]</a>, <a href="reserved_domains.html#module-ngrok.services">[26]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[27]</a>, <a href="ssh_credentials.html#module-ngrok.services">[28]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[29]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[30]</a>, <a href="tls_certificates.html#module-ngrok.services">[31]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[32]</a>, <a href="tunnels.html#module-ngrok.services">[33]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.not_after">not_after() (ngrok.datatypes.CertificateAuthority property)</a>
|
||||
@@ -1505,6 +1565,12 @@
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.single_logout_url">single_logout_url() (ngrok.datatypes.EndpointSAML property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSourceList.sources">sources() (ngrok.datatypes.EventSourceList property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription.sources">(ngrok.datatypes.EventSubscription property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="client.html#ngrok.Client.ssh_certificate_authorities">ssh_certificate_authorities() (ngrok.Client property)</a>
|
||||
|
||||
<ul>
|
||||
@@ -1538,11 +1604,11 @@
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient">SSHCertificateAuthoritiesClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<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.SSHCertificateAuthorityList">SSHCertificateAuthorityList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<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>
|
||||
@@ -1635,10 +1701,10 @@
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSession.transport">transport() (ngrok.datatypes.TunnelSession property)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker.tripped_duration">tripped_duration() (ngrok.datatypes.EndpointCircuitBreaker property)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Tunnel">Tunnel (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Tunnel.tunnel_session">tunnel_session() (ngrok.datatypes.Tunnel property)</a>
|
||||
@@ -1668,6 +1734,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointConfiguration.type">type() (ngrok.datatypes.EndpointConfiguration property)</a>
|
||||
|
||||
<ul>
|
||||
<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>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPRestriction.type">(ngrok.datatypes.IPRestriction property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
@@ -1715,8 +1785,12 @@
|
||||
<li><a href="endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.update">(ngrok.services.EndpointConfigurationsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_destinations.html#ngrok.services.EventDestinationsClient.update">(ngrok.services.EventDestinationsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_sources.html#ngrok.services.EventSourcesClient.update">(ngrok.services.EventSourcesClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_streams.html#ngrok.services.EventStreamsClient.update">(ngrok.services.EventStreamsClient method)</a>
|
||||
</li>
|
||||
<li><a href="event_subscriptions.html#ngrok.services.EventSubscriptionsClient.update">(ngrok.services.EventSubscriptionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ip_policies.html#ngrok.services.IPPoliciesClient.update">(ngrok.services.IPPoliciesClient method)</a>
|
||||
</li>
|
||||
@@ -1765,10 +1839,18 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestination.uri">(ngrok.datatypes.EventDestination property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventDestinationList.uri">(ngrok.datatypes.EventDestinationList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSource.uri">(ngrok.datatypes.EventSource property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSourceList.uri">(ngrok.datatypes.EventSourceList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStream.uri">(ngrok.datatypes.EventStream property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventStreamList.uri">(ngrok.datatypes.EventStreamList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription.uri">(ngrok.datatypes.EventSubscription property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscriptionList.uri">(ngrok.datatypes.EventSubscriptionList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicy.uri">(ngrok.datatypes.IPPolicy property)</a>
|
||||
</li>
|
||||
|
||||
+9
-5
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -196,8 +198,8 @@ object. That’s it!</p>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="transparent-paging">
|
||||
<h3>Transparent Paging<a class="headerlink" href="#transparent-paging" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="automatic-paging">
|
||||
<h3>Automatic Paging<a class="headerlink" href="#automatic-paging" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The ngrok API pages all list resources but this library abstracts that away
|
||||
from you. All response objects from any <code class="docutils literal notranslate"><span class="pre">list()</span></code> methods return an object that
|
||||
implements an <code class="docutils literal notranslate"><span class="pre">__iter__()</span></code> method which will automatically fetch additional
|
||||
@@ -270,13 +272,15 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -351,7 +355,7 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li><a class="reference internal" href="#getting-started">Getting Started</a><ul>
|
||||
<li><a class="reference internal" href="#installation">Installation</a></li>
|
||||
<li><a class="reference internal" href="#quickstart-example">Quickstart Example</a></li>
|
||||
<li><a class="reference internal" href="#transparent-paging">Transparent Paging</a></li>
|
||||
<li><a class="reference internal" href="#automatic-paging">Automatic Paging</a></li>
|
||||
<li><a class="reference internal" href="#instance-methods">Instance Methods</a></li>
|
||||
<li><a class="reference internal" href="#error-handling">Error Handling</a></li>
|
||||
</ul>
|
||||
|
||||
+11
-5
@@ -2,7 +2,7 @@
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="IP Policy Rules" href="ip_policy_rules.html" /><link rel="prev" title="Event Destinations" href="event_destinations.html" />
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="IP Policy Rules" href="ip_policy_rules.html" /><link rel="prev" title="Event Sources" href="event_sources.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>IP Policies - ngrok-api documentation</title>
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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 current current-page"><a class="current reference internal" href="#">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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,11 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.IPPoliciesClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">IPPoliciesClient</span></code><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#IPPoliciesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPPoliciesClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>IP Policies are reusable groups of CIDR ranges with an <code class="docutils literal notranslate"><span class="pre">allow</span></code> or <code class="docutils literal notranslate"><span class="pre">deny</span></code>
|
||||
action. They can be attached to endpoints via the Endpoint Configuration IP
|
||||
Policy module. They can also be used with IP Restrictions to control source
|
||||
IP ranges that can start tunnel sessions and connect to the API and dashboard.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.IPPoliciesClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">action</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#IPPoliciesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPPoliciesClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.</p>
|
||||
@@ -270,14 +276,14 @@
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="event_destinations.html">
|
||||
<a class="prev-page" href="event_sources.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Event Destinations</div>
|
||||
<div class="title">Event Sources</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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 current current-page"><a class="current reference internal" href="#">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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,9 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.IPPolicyRulesClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">IPPolicyRulesClient</span></code><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#IPPolicyRulesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPPolicyRulesClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
|
||||
make up an IP Policy.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.IPPolicyRulesClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cidr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_policy_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">''</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#IPPolicyRulesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPPolicyRulesClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new IP policy rule attached to an IP Policy.</p>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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 current current-page"><a class="current reference internal" href="#">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,13 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.IPRestrictionsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">IPRestrictionsClient</span></code><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#IPRestrictionsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPRestrictionsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>An IP restriction is a restriction placed on the CIDRs that are allowed to
|
||||
initate traffic to a specific aspect of your ngrok account. An IP
|
||||
restriction has a type which defines the ingress it applies to. IP
|
||||
restrictions can be used to enforce the source IPs that can make API
|
||||
requests, log in to the dashboard, start ngrok agents, and connect to your
|
||||
public-facing endpoints.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.IPRestrictionsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_policy_ids</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">enforced</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#IPRestrictionsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPRestrictionsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new IP restriction</p>
|
||||
@@ -177,7 +185,7 @@
|
||||
<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 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 enforce. if false, only warnings will be issued</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>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: <code class="docutils literal notranslate"><span class="pre">dashboard</span></code>, <code class="docutils literal notranslate"><span class="pre">api</span></code>, <code class="docutils literal notranslate"><span class="pre">agent</span></code>, and <code class="docutils literal notranslate"><span class="pre">endpoints</span></code></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>
|
||||
@@ -246,7 +254,7 @@
|
||||
<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>]) – 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>]) – 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>]) – true if the IP restriction will be enforce. if false, only warnings will be issued</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>]) – 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>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<html class="no-js">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Endpoint Configurations" href="endpoint_configurations.html" /><link rel="prev" title="IP Restrictions" href="ip_restrictions.html" />
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Logging Module" href="endpoint_logging_module.html" /><link rel="prev" title="IP Restrictions" href="ip_restrictions.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>IP Whitelist - ngrok-api documentation</title>
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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 current current-page"><a class="current reference internal" href="#">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,9 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.IPWhitelistClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">IPWhitelistClient</span></code><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#IPWhitelistClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPWhitelistClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction
|
||||
with an <code class="docutils literal notranslate"><span class="pre">endpoints</span></code> type instead.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.IPWhitelistClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><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">ip_net</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#IPWhitelistClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPWhitelistClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new IP whitelist entry that will restrict traffic to all tunnel endpoints on the account.</p>
|
||||
@@ -261,12 +265,12 @@
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="endpoint_configurations.html">
|
||||
<a class="next-page" href="endpoint_logging_module.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Endpoint Configurations</div>
|
||||
<div class="title">Logging Module</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
Binary file not shown.
@@ -118,13 +118,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,10 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.ReservedAddrsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">ReservedAddrsClient</span></code><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#ReservedAddrsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedAddrsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>Reserved Addresses are TCP addresses that can be used to listen for traffic.
|
||||
TCP address hostnames and ports are assigned by ngrok, they cannot be
|
||||
chosen.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.ReservedAddrsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><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">region</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">endpoint_configuration_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ReservedAddrsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedAddrsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new reserved address.</p>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,9 +170,13 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.ReservedDomainsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">ReservedDomainsClient</span></code><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#ReservedDomainsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedDomainsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>Reserved Domains are hostnames that you can listen for traffic on. Domains
|
||||
can be used to listen for http, https or tls traffic. You may use a domain
|
||||
that you own by creating a CNAME record specified in the returned resource.
|
||||
This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.ReservedDomainsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</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">http_endpoint_configuration_id</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">https_endpoint_configuration_id</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">certificate_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">certificate_management_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#ReservedDomainsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedDomainsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</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">http_endpoint_configuration_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">https_endpoint_configuration_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">certificate_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">certificate_management_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#ReservedDomainsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedDomainsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new reserved domain.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@@ -179,8 +185,8 @@
|
||||
<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>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>http_endpoint_configuration_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p></li>
|
||||
<li><p><strong>https_endpoint_configuration_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p></li>
|
||||
<li><p><strong>http_endpoint_configuration_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>]) – ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p></li>
|
||||
<li><p><strong>https_endpoint_configuration_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>]) – ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</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>]) – 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>]) – 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>
|
||||
|
||||
+3
-1
@@ -117,13 +117,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,9 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.SSHCertificateAuthoritiesClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">SSHCertificateAuthoritiesClient</span></code><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#SSHCertificateAuthoritiesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCertificateAuthoritiesClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
||||
key that can be used to sign other SSH host and user certificates.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.SSHCertificateAuthoritiesClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><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">private_key_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">elliptic_curve</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">key_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHCertificateAuthoritiesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCertificateAuthoritiesClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new SSH Certificate Authority</p>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,9 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.SSHCredentialsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">SSHCredentialsClient</span></code><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#SSHCredentialsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCredentialsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>SSH Credentials are SSH public keys that can be used to start SSH tunnels
|
||||
via the ngrok SSH tunnel gateway.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.SSHCredentialsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">public_key</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">acl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHCredentialsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCredentialsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok’s SSH gateway.</p>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,10 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.SSHHostCertificatesClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">SSHHostCertificatesClient</span></code><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#SSHHostCertificatesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHHostCertificatesClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>SSH Host Certificates along with the corresponding private key allows an SSH
|
||||
server to assert its authenticity to connecting SSH clients who trust the
|
||||
SSH Certificate Authority that was used to sign the certificate.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.SSHHostCertificatesClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssh_certificate_authority_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">principals</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">valid_after</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">valid_until</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHHostCertificatesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHHostCertificatesClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new SSH Host Certificate</p>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,10 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.SSHUserCertificatesClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">SSHUserCertificatesClient</span></code><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#SSHUserCertificatesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHUserCertificatesClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>SSH User Certificates are presented by SSH clients when connecting to an SSH
|
||||
server to authenticate their connection. The SSH server must trust the SSH
|
||||
Certificate Authority used to sign the certificate.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.SSHUserCertificatesClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssh_certificate_authority_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">principals</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">critical_options</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">extensions</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">valid_after</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">valid_until</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHUserCertificatesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHUserCertificatesClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new SSH User Certificate</p>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,12 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.TLSCertificatesClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">TLSCertificatesClient</span></code><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#TLSCertificatesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TLSCertificatesClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>TLS Certificates are pairs of x509 certificates and their matching private
|
||||
key that can be used to terminate TLS traffic. TLS certificates are unused
|
||||
until they are attached to a Domain. TLS Certificates may also be
|
||||
provisioned by ngrok automatically for domains on which you have enabled
|
||||
automated certificate provisioning.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.TLSCertificatesClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">certificate_pem</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">private_key_pem</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TLSCertificatesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TLSCertificatesClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Upload a new TLS certificate</p>
|
||||
|
||||
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,10 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.TunnelSessionsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">TunnelSessionsClient</span></code><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#TunnelSessionsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TunnelSessionsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>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.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.TunnelSessionsClient.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><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#TunnelSessionsClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TunnelSessionsClient.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the detailed status of a tunnel session by ID</p>
|
||||
|
||||
+6
-2
@@ -119,13 +119,15 @@
|
||||
<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="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="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="ip_whitelist.html">IP Whitelist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||||
@@ -168,7 +170,9 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.TunnelsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">TunnelsClient</span></code><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#TunnelsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TunnelsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dd><p>Tunnels provide endpoints to access services exposed by a running ngrok
|
||||
agent tunnel session or an SSH reverse tunnel session.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.TunnelsClient.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><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#TunnelsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TunnelsClient.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List all online tunnels currently running on the account.</p>
|
||||
|
||||
+72
-6
@@ -10,20 +10,43 @@ class Client(object):
|
||||
|
||||
@property
|
||||
def abuse_reports(self) -> AbuseReportsClient:
|
||||
"""Abuse Reports allow you to submit take-down requests for URLs hosted by
|
||||
ngrok that violate ngrok's terms of service."""
|
||||
return AbuseReportsClient(self)
|
||||
|
||||
@property
|
||||
def api_keys(self) -> APIKeysClient:
|
||||
"""API Keys are used to authenticate to the `ngrok
|
||||
API` <https://ngrok.com/docs/api#authentication>`_. You may use the API itself
|
||||
to provision and manage API Keys but you'll need to provision your first API
|
||||
key from the `API Keys page` <https://dashboard.ngrok.com/api/keys>`_ on your
|
||||
ngrok.com dashboard."""
|
||||
return APIKeysClient(self)
|
||||
|
||||
@property
|
||||
def certificate_authorities(self) -> CertificateAuthoritiesClient:
|
||||
"""Certificate Authorities are x509 certificates that are used to sign other
|
||||
x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
||||
to verify that the TLS certificate presented by a client has been signed by
|
||||
this CA. Certificate Authorities are used only for mTLS validation only and
|
||||
thus a private key is not included in the resource."""
|
||||
return CertificateAuthoritiesClient(self)
|
||||
|
||||
@property
|
||||
def credentials(self) -> CredentialsClient:
|
||||
"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
||||
agent to connect the ngrok service as your account. They are installed with
|
||||
the ``ngrok authtoken`` command or by specifying it in the ``ngrok.yml``
|
||||
configuration file with the ``authtoken`` property."""
|
||||
return CredentialsClient(self)
|
||||
|
||||
@property
|
||||
def endpoint_configurations(self) -> EndpointConfigurationsClient:
|
||||
"""Endpoint Configurations are a reusable group of modules that encapsulate how
|
||||
traffic to a domain or address is handled. Endpoint configurations are only
|
||||
applied to Domains and TCP Addresses they have been attached to."""
|
||||
return EndpointConfigurationsClient(self)
|
||||
|
||||
@property
|
||||
def event_streams(self) -> EventStreamsClient:
|
||||
return EventStreamsClient(self)
|
||||
@@ -32,62 +55,105 @@ class Client(object):
|
||||
def event_destinations(self) -> EventDestinationsClient:
|
||||
return EventDestinationsClient(self)
|
||||
|
||||
@property
|
||||
def event_subscriptions(self) -> EventSubscriptionsClient:
|
||||
return EventSubscriptionsClient(self)
|
||||
|
||||
@property
|
||||
def event_sources(self) -> EventSourcesClient:
|
||||
return EventSourcesClient(self)
|
||||
|
||||
@property
|
||||
def ip_policies(self) -> IPPoliciesClient:
|
||||
"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``
|
||||
action. They can be attached to endpoints via the Endpoint Configuration IP
|
||||
Policy module. They can also be used with IP Restrictions to control source
|
||||
IP ranges that can start tunnel sessions and connect to the API and dashboard."""
|
||||
return IPPoliciesClient(self)
|
||||
|
||||
@property
|
||||
def ip_policy_rules(self) -> IPPolicyRulesClient:
|
||||
"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
|
||||
make up an IP Policy."""
|
||||
return IPPolicyRulesClient(self)
|
||||
|
||||
@property
|
||||
def ip_restrictions(self) -> IPRestrictionsClient:
|
||||
"""An IP restriction is a restriction placed on the CIDRs that are allowed to
|
||||
initate traffic to a specific aspect of your ngrok account. An IP
|
||||
restriction has a type which defines the ingress it applies to. IP
|
||||
restrictions can be used to enforce the source IPs that can make API
|
||||
requests, log in to the dashboard, start ngrok agents, and connect to your
|
||||
public-facing endpoints."""
|
||||
return IPRestrictionsClient(self)
|
||||
|
||||
@property
|
||||
def ip_whitelist(self) -> IPWhitelistClient:
|
||||
"""The IP Whitelist is deprecated and will be removed. Use an IP Restriction
|
||||
with an ``endpoints`` type instead."""
|
||||
return IPWhitelistClient(self)
|
||||
|
||||
@property
|
||||
def endpoint_configurations(self) -> EndpointConfigurationsClient:
|
||||
"""Endpoint Configuration managementAn `Endpoint Configuration` <https://ngrok.com/docs/ngrok-link#api-endpoint-configurations>`_ describes
|
||||
a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!*"""
|
||||
return EndpointConfigurationsClient(self)
|
||||
|
||||
@property
|
||||
def reserved_addrs(self) -> ReservedAddrsClient:
|
||||
"""Reserved Addresses are TCP addresses that can be used to listen for traffic.
|
||||
TCP address hostnames and ports are assigned by ngrok, they cannot be
|
||||
chosen."""
|
||||
return ReservedAddrsClient(self)
|
||||
|
||||
@property
|
||||
def reserved_domains(self) -> ReservedDomainsClient:
|
||||
"""Reserved Domains are hostnames that you can listen for traffic on. Domains
|
||||
can be used to listen for http, https or tls traffic. You may use a domain
|
||||
that you own by creating a CNAME record specified in the returned resource.
|
||||
This CNAME record points traffic for that domain to ngrok's edge servers."""
|
||||
return ReservedDomainsClient(self)
|
||||
|
||||
@property
|
||||
def ssh_certificate_authorities(self) -> SSHCertificateAuthoritiesClient:
|
||||
"""An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
||||
key that can be used to sign other SSH host and user certificates."""
|
||||
return SSHCertificateAuthoritiesClient(self)
|
||||
|
||||
@property
|
||||
def ssh_credentials(self) -> SSHCredentialsClient:
|
||||
"""SSH Credentials are SSH public keys that can be used to start SSH tunnels
|
||||
via the ngrok SSH tunnel gateway."""
|
||||
return SSHCredentialsClient(self)
|
||||
|
||||
@property
|
||||
def ssh_host_certificates(self) -> SSHHostCertificatesClient:
|
||||
"""SSH Host Certificates along with the corresponding private key allows an SSH
|
||||
server to assert its authenticity to connecting SSH clients who trust the
|
||||
SSH Certificate Authority that was used to sign the certificate."""
|
||||
return SSHHostCertificatesClient(self)
|
||||
|
||||
@property
|
||||
def ssh_user_certificates(self) -> SSHUserCertificatesClient:
|
||||
"""SSH User Certificates are presented by SSH clients when connecting to an SSH
|
||||
server to authenticate their connection. The SSH server must trust the SSH
|
||||
Certificate Authority used to sign the certificate."""
|
||||
return SSHUserCertificatesClient(self)
|
||||
|
||||
@property
|
||||
def tls_certificates(self) -> TLSCertificatesClient:
|
||||
"""TLS Certificates are pairs of x509 certificates and their matching private
|
||||
key that can be used to terminate TLS traffic. TLS certificates are unused
|
||||
until they are attached to a Domain. TLS Certificates may also be
|
||||
provisioned by ngrok automatically for domains on which you have enabled
|
||||
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
|
||||
agent tunnel session or an SSH reverse tunnel session."""
|
||||
return TunnelsClient(self)
|
||||
|
||||
@property
|
||||
|
||||
+1252
-890
File diff suppressed because it is too large
Load Diff
+492
-191
@@ -7,6 +7,9 @@ from .datatypes import *
|
||||
|
||||
|
||||
class AbuseReportsClient(object):
|
||||
"""Abuse Reports allow you to submit take-down requests for URLs hosted by
|
||||
ngrok that violate ngrok's terms of service."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -51,6 +54,12 @@ class AbuseReportsClient(object):
|
||||
|
||||
|
||||
class APIKeysClient(object):
|
||||
"""API Keys are used to authenticate to the `ngrok
|
||||
API` <https://ngrok.com/docs/api#authentication>`_. You may use the API itself
|
||||
to provision and manage API Keys but you'll need to provision your first API
|
||||
key from the `API Keys page` <https://dashboard.ngrok.com/api/keys>`_ on your
|
||||
ngrok.com dashboard."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -160,6 +169,12 @@ class APIKeysClient(object):
|
||||
|
||||
|
||||
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
|
||||
to verify that the TLS certificate presented by a client has been signed by
|
||||
this CA. Certificate Authorities are used only for mTLS validation only and
|
||||
thus a private key is not included in the resource."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -272,6 +287,11 @@ class CertificateAuthoritiesClient(object):
|
||||
|
||||
|
||||
class CredentialsClient(object):
|
||||
"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
||||
agent to connect the ngrok service as your account. They are installed with
|
||||
the ``ngrok authtoken`` command or by specifying it in the ``ngrok.yml``
|
||||
configuration file with the ``authtoken`` property."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -386,6 +406,194 @@ class CredentialsClient(object):
|
||||
return Credential(self._client, result)
|
||||
|
||||
|
||||
class EndpointConfigurationsClient(object):
|
||||
"""Endpoint Configurations are a reusable group of modules that encapsulate how
|
||||
traffic to a domain or address is handled. Endpoint configurations are only
|
||||
applied to Domains and TCP Addresses they have been attached to."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def create(
|
||||
self,
|
||||
type: str = "",
|
||||
description: str = "",
|
||||
metadata: str = "",
|
||||
circuit_breaker: EndpointCircuitBreaker = None,
|
||||
compression: EndpointCompression = None,
|
||||
request_headers: EndpointRequestHeaders = None,
|
||||
response_headers: EndpointResponseHeaders = None,
|
||||
ip_policy: EndpointIPPolicyMutate = None,
|
||||
mutual_tls: EndpointMutualTLSMutate = None,
|
||||
tls_termination: EndpointTLSTermination = None,
|
||||
webhook_validation: EndpointWebhookValidation = None,
|
||||
oauth: EndpointOAuth = None,
|
||||
logging: EndpointLoggingMutate = None,
|
||||
saml: EndpointSAMLMutate = None,
|
||||
oidc: EndpointOIDC = None,
|
||||
) -> EndpointConfiguration:
|
||||
"""Create a new endpoint configuration
|
||||
|
||||
:param type: they type of traffic this endpoint configuration can be applied to. one of: ``http``, ``https``, ``tcp``
|
||||
:param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
|
||||
:param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
|
||||
:param circuit_breaker: circuit breaker module configuration or ``null``
|
||||
:param compression: compression module configuration or ``null``
|
||||
:param request_headers: request headers module configuration or ``null``
|
||||
:param response_headers: response headers module configuration or ``null``
|
||||
:param ip_policy: ip policy module configuration or ``null``
|
||||
:param mutual_tls: mutual TLS module configuration or ``null``
|
||||
:param tls_termination: TLS termination module configuration or ``null``
|
||||
:param webhook_validation: webhook validation module configuration or ``null``
|
||||
:param oauth: oauth module configuration or ``null``
|
||||
:param logging: logging module configuration or ``null``
|
||||
:param saml: saml module configuration or ``null``
|
||||
:param oidc: oidc module configuration or ``null``
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-create
|
||||
"""
|
||||
path = "/endpoint_configurations"
|
||||
result = self._client.http_client.post(
|
||||
path,
|
||||
dict(
|
||||
type=type,
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
circuit_breaker=circuit_breaker,
|
||||
compression=compression,
|
||||
request_headers=request_headers,
|
||||
response_headers=response_headers,
|
||||
ip_policy=ip_policy,
|
||||
mutual_tls=mutual_tls,
|
||||
tls_termination=tls_termination,
|
||||
webhook_validation=webhook_validation,
|
||||
oauth=oauth,
|
||||
logging=logging,
|
||||
saml=saml,
|
||||
oidc=oidc,
|
||||
),
|
||||
)
|
||||
return EndpointConfiguration(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-delete
|
||||
"""
|
||||
path = "/endpoint_configurations/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
self._client.http_client.delete(path, dict())
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> EndpointConfiguration:
|
||||
"""Returns detailed information about an endpoint configuration
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-get
|
||||
"""
|
||||
path = "/endpoint_configurations/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
result = self._client.http_client.get(path, dict())
|
||||
return EndpointConfiguration(self._client, result)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
) -> EndpointConfigurationList:
|
||||
"""Returns a list of all endpoint configurations on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-list
|
||||
"""
|
||||
path = "/endpoint_configurations"
|
||||
result = self._client.http_client.get(
|
||||
path,
|
||||
dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
),
|
||||
)
|
||||
return EndpointConfigurationList(self._client, result)
|
||||
|
||||
def update(
|
||||
self,
|
||||
id: str,
|
||||
description: str = None,
|
||||
metadata: str = None,
|
||||
circuit_breaker: EndpointCircuitBreaker = None,
|
||||
compression: EndpointCompression = None,
|
||||
request_headers: EndpointRequestHeaders = None,
|
||||
response_headers: EndpointResponseHeaders = None,
|
||||
ip_policy: EndpointIPPolicyMutate = None,
|
||||
mutual_tls: EndpointMutualTLSMutate = None,
|
||||
tls_termination: EndpointTLSTermination = None,
|
||||
webhook_validation: EndpointWebhookValidation = None,
|
||||
oauth: EndpointOAuth = None,
|
||||
logging: EndpointLoggingMutate = None,
|
||||
saml: EndpointSAMLMutate = None,
|
||||
oidc: EndpointOIDC = None,
|
||||
) -> EndpointConfiguration:
|
||||
"""Updates an endpoint configuration. 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.
|
||||
|
||||
:param id: unique identifier of this endpoint configuration
|
||||
:param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
|
||||
:param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
|
||||
:param circuit_breaker: circuit breaker module configuration or ``null``
|
||||
:param compression: compression module configuration or ``null``
|
||||
:param request_headers: request headers module configuration or ``null``
|
||||
:param response_headers: response headers module configuration or ``null``
|
||||
:param ip_policy: ip policy module configuration or ``null``
|
||||
:param mutual_tls: mutual TLS module configuration or ``null``
|
||||
:param tls_termination: TLS termination module configuration or ``null``
|
||||
:param webhook_validation: webhook validation module configuration or ``null``
|
||||
:param oauth: oauth module configuration or ``null``
|
||||
:param logging: logging module configuration or ``null``
|
||||
:param saml: saml module configuration or ``null``
|
||||
:param oidc: oidc module configuration or ``null``
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-update
|
||||
"""
|
||||
path = "/endpoint_configurations/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
result = self._client.http_client.patch(
|
||||
path,
|
||||
dict(
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
circuit_breaker=circuit_breaker,
|
||||
compression=compression,
|
||||
request_headers=request_headers,
|
||||
response_headers=response_headers,
|
||||
ip_policy=ip_policy,
|
||||
mutual_tls=mutual_tls,
|
||||
tls_termination=tls_termination,
|
||||
webhook_validation=webhook_validation,
|
||||
oauth=oauth,
|
||||
logging=logging,
|
||||
saml=saml,
|
||||
oidc=oidc,
|
||||
),
|
||||
)
|
||||
return EndpointConfiguration(self._client, result)
|
||||
|
||||
|
||||
class EventStreamsClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
@@ -637,7 +845,238 @@ class EventDestinationsClient(object):
|
||||
return EventDestination(self._client, result)
|
||||
|
||||
|
||||
class EventSubscriptionsClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def create(
|
||||
self,
|
||||
metadata: str = "",
|
||||
description: str = "",
|
||||
sources: Sequence[EventSourceReplace] = [],
|
||||
destination_ids: Sequence[str] = [],
|
||||
) -> EventSubscription:
|
||||
"""Create an Event Subscription.
|
||||
|
||||
:param metadata: Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
|
||||
:param description: Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
|
||||
:param sources: Sources containing the types for which this event subscription will trigger
|
||||
:param destination_ids: A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
|
||||
|
||||
https://ngrok.com/docs/api#api-event-subscriptions-create
|
||||
"""
|
||||
path = "/event_subscriptions"
|
||||
result = self._client.http_client.post(
|
||||
path,
|
||||
dict(
|
||||
metadata=metadata,
|
||||
description=description,
|
||||
sources=sources,
|
||||
destination_ids=destination_ids,
|
||||
),
|
||||
)
|
||||
return EventSubscription(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete an Event Subscription.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-event-subscriptions-delete
|
||||
"""
|
||||
path = "/event_subscriptions/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
self._client.http_client.delete(path, dict())
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> EventSubscription:
|
||||
"""Get an Event Subscription by ID.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-event-subscriptions-get
|
||||
"""
|
||||
path = "/event_subscriptions/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
result = self._client.http_client.get(path, dict())
|
||||
return EventSubscription(self._client, result)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
) -> EventSubscriptionList:
|
||||
"""List this Account's Event Subscriptions.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
|
||||
https://ngrok.com/docs/api#api-event-subscriptions-list
|
||||
"""
|
||||
path = "/event_subscriptions"
|
||||
result = self._client.http_client.get(
|
||||
path,
|
||||
dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
),
|
||||
)
|
||||
return EventSubscriptionList(self._client, result)
|
||||
|
||||
def update(
|
||||
self,
|
||||
id: str,
|
||||
metadata: str = None,
|
||||
description: str = None,
|
||||
sources: Sequence[EventSourceReplace] = None,
|
||||
destination_ids: Sequence[str] = None,
|
||||
) -> EventSubscription:
|
||||
"""Update an Event Subscription.
|
||||
|
||||
:param id: Unique identifier for this Event Subscription.
|
||||
:param metadata: Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
|
||||
:param description: Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
|
||||
:param sources: Sources containing the types for which this event subscription will trigger
|
||||
:param destination_ids: A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
|
||||
|
||||
https://ngrok.com/docs/api#api-event-subscriptions-update
|
||||
"""
|
||||
path = "/event_subscriptions/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
result = self._client.http_client.patch(
|
||||
path,
|
||||
dict(
|
||||
metadata=metadata,
|
||||
description=description,
|
||||
sources=sources,
|
||||
destination_ids=destination_ids,
|
||||
),
|
||||
)
|
||||
return EventSubscription(self._client, result)
|
||||
|
||||
|
||||
class EventSourcesClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def create(
|
||||
self,
|
||||
subscription_id: str,
|
||||
type: str = "",
|
||||
) -> EventSource:
|
||||
"""Add an additional type for which this event subscription will trigger
|
||||
|
||||
:param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.
|
||||
:param type: Type of event for which an event subscription will trigger
|
||||
|
||||
https://ngrok.com/docs/api#api-event-sources-create
|
||||
"""
|
||||
path = "/event_subscriptions/{subscription_id}/sources"
|
||||
path = path.format(
|
||||
subscription_id=subscription_id,
|
||||
)
|
||||
result = self._client.http_client.post(
|
||||
path,
|
||||
dict(
|
||||
type=type,
|
||||
),
|
||||
)
|
||||
return EventSource(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
subscription_id: str,
|
||||
type: str,
|
||||
):
|
||||
"""Remove a type for which this event subscription will trigger
|
||||
|
||||
:param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.
|
||||
:param type: Type of event for which an event subscription will trigger
|
||||
|
||||
https://ngrok.com/docs/api#api-event-sources-delete
|
||||
"""
|
||||
path = "/event_subscriptions/{subscription_id}/sources/{type}"
|
||||
path = path.format(
|
||||
subscription_id=subscription_id,
|
||||
type=type,
|
||||
)
|
||||
self._client.http_client.delete(path, dict())
|
||||
|
||||
def get(
|
||||
self,
|
||||
subscription_id: str,
|
||||
type: str,
|
||||
) -> EventSource:
|
||||
"""Get the details for a given type that triggers for the given event subscription
|
||||
|
||||
:param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.
|
||||
:param type: Type of event for which an event subscription will trigger
|
||||
|
||||
https://ngrok.com/docs/api#api-event-sources-get
|
||||
"""
|
||||
path = "/event_subscriptions/{subscription_id}/sources/{type}"
|
||||
path = path.format(
|
||||
subscription_id=subscription_id,
|
||||
type=type,
|
||||
)
|
||||
result = self._client.http_client.get(path, dict())
|
||||
return EventSource(self._client, result)
|
||||
|
||||
def list(
|
||||
self,
|
||||
subscription_id: str,
|
||||
) -> EventSourceList:
|
||||
"""List the types for which this event subscription will trigger
|
||||
|
||||
:param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.
|
||||
|
||||
https://ngrok.com/docs/api#api-event-sources-list
|
||||
"""
|
||||
path = "/event_subscriptions/{subscription_id}/sources"
|
||||
path = path.format(
|
||||
subscription_id=subscription_id,
|
||||
)
|
||||
result = self._client.http_client.get(path, dict())
|
||||
return EventSourceList(self._client, result)
|
||||
|
||||
def update(
|
||||
self,
|
||||
subscription_id: str,
|
||||
type: str,
|
||||
) -> EventSource:
|
||||
"""Update the type for which this event subscription will trigger
|
||||
|
||||
:param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.
|
||||
:param type: Type of event for which an event subscription will trigger
|
||||
|
||||
https://ngrok.com/docs/api#api-event-sources-update
|
||||
"""
|
||||
path = "/event_subscriptions/{subscription_id}/sources/{type}"
|
||||
path = path.format(
|
||||
subscription_id=subscription_id,
|
||||
type=type,
|
||||
)
|
||||
result = self._client.http_client.patch(path, dict())
|
||||
return EventSource(self._client, result)
|
||||
|
||||
|
||||
class IPPoliciesClient(object):
|
||||
"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``
|
||||
action. They can be attached to endpoints via the Endpoint Configuration IP
|
||||
Policy module. They can also be used with IP Restrictions to control source
|
||||
IP ranges that can start tunnel sessions and connect to the API and dashboard."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -750,6 +1189,9 @@ class IPPoliciesClient(object):
|
||||
|
||||
|
||||
class IPPolicyRulesClient(object):
|
||||
"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
|
||||
make up an IP Policy."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -868,6 +1310,13 @@ class IPPolicyRulesClient(object):
|
||||
|
||||
|
||||
class IPRestrictionsClient(object):
|
||||
"""An IP restriction is a restriction placed on the CIDRs that are allowed to
|
||||
initate traffic to a specific aspect of your ngrok account. An IP
|
||||
restriction has a type which defines the ingress it applies to. IP
|
||||
restrictions can be used to enforce the source IPs that can make API
|
||||
requests, log in to the dashboard, start ngrok agents, and connect to your
|
||||
public-facing endpoints."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -883,7 +1332,7 @@ class IPRestrictionsClient(object):
|
||||
|
||||
:param description: human-readable description of this IP restriction. optional, max 255 bytes.
|
||||
:param metadata: arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
|
||||
:param enforced: true if the IP restriction will be enforce. if false, only warnings will be issued
|
||||
:param enforced: true if the IP restriction will be enforced. if false, only warnings will be issued
|
||||
:param type: the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: ``dashboard``, ``api``, ``agent``, and ``endpoints``
|
||||
:param ip_policy_ids: the set of IP policy identifiers that are used to enforce the restriction
|
||||
|
||||
@@ -970,7 +1419,7 @@ class IPRestrictionsClient(object):
|
||||
:param id:
|
||||
:param description: human-readable description of this IP restriction. optional, max 255 bytes.
|
||||
:param metadata: arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
|
||||
:param enforced: true if the IP restriction will be enforce. if false, only warnings will be issued
|
||||
:param enforced: true if the IP restriction will be enforced. if false, only warnings will be issued
|
||||
:param ip_policy_ids: the set of IP policy identifiers that are used to enforce the restriction
|
||||
|
||||
https://ngrok.com/docs/api#api-ip-restrictions-update
|
||||
@@ -992,6 +1441,9 @@ class IPRestrictionsClient(object):
|
||||
|
||||
|
||||
class IPWhitelistClient(object):
|
||||
"""The IP Whitelist is deprecated and will be removed. Use an IP Restriction
|
||||
with an ``endpoints`` type instead."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -1103,193 +1555,6 @@ class IPWhitelistClient(object):
|
||||
return IPWhitelistEntry(self._client, result)
|
||||
|
||||
|
||||
class EndpointConfigurationsClient(object):
|
||||
"""Endpoint Configuration managementAn `Endpoint Configuration` <https://ngrok.com/docs/ngrok-link#api-endpoint-configurations>`_ describes
|
||||
a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!*"""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def create(
|
||||
self,
|
||||
type: str = "",
|
||||
description: str = "",
|
||||
metadata: str = "",
|
||||
circuit_breaker: EndpointCircuitBreaker = None,
|
||||
compression: EndpointCompression = None,
|
||||
request_headers: EndpointRequestHeaders = None,
|
||||
response_headers: EndpointResponseHeaders = None,
|
||||
ip_policy: EndpointIPPolicyMutate = None,
|
||||
mutual_tls: EndpointMutualTLSMutate = None,
|
||||
tls_termination: EndpointTLSTermination = None,
|
||||
webhook_validation: EndpointWebhookValidation = None,
|
||||
oauth: EndpointOAuth = None,
|
||||
logging: EndpointLoggingMutate = None,
|
||||
saml: EndpointSAMLMutate = None,
|
||||
oidc: EndpointOIDC = None,
|
||||
) -> EndpointConfiguration:
|
||||
"""Create a new endpoint configuration
|
||||
|
||||
:param type: they type of traffic this endpoint configuration can be applied to. one of: ``http``, ``https``, ``tcp``
|
||||
:param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
|
||||
:param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
|
||||
:param circuit_breaker: circuit breaker module configuration or ``null``
|
||||
:param compression: compression module configuration or ``null``
|
||||
:param request_headers: request headers module configuration or ``null``
|
||||
:param response_headers: response headers module configuration or ``null``
|
||||
:param ip_policy: ip policy module configuration or ``null``
|
||||
:param mutual_tls: mutual TLS module configuration or ``null``
|
||||
:param tls_termination: TLS termination module configuration or ``null``
|
||||
:param webhook_validation: webhook validation module configuration or ``null``
|
||||
:param oauth: oauth module configuration or ``null``
|
||||
:param logging: logging module configuration or ``null``
|
||||
:param saml: saml module configuration or ``null``
|
||||
:param oidc: oidc module configuration or ``null``
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-create
|
||||
"""
|
||||
path = "/endpoint_configurations"
|
||||
result = self._client.http_client.post(
|
||||
path,
|
||||
dict(
|
||||
type=type,
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
circuit_breaker=circuit_breaker,
|
||||
compression=compression,
|
||||
request_headers=request_headers,
|
||||
response_headers=response_headers,
|
||||
ip_policy=ip_policy,
|
||||
mutual_tls=mutual_tls,
|
||||
tls_termination=tls_termination,
|
||||
webhook_validation=webhook_validation,
|
||||
oauth=oauth,
|
||||
logging=logging,
|
||||
saml=saml,
|
||||
oidc=oidc,
|
||||
),
|
||||
)
|
||||
return EndpointConfiguration(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-delete
|
||||
"""
|
||||
path = "/endpoint_configurations/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
self._client.http_client.delete(path, dict())
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> EndpointConfiguration:
|
||||
"""Returns detailed information about an endpoint configuration
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-get
|
||||
"""
|
||||
path = "/endpoint_configurations/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
result = self._client.http_client.get(path, dict())
|
||||
return EndpointConfiguration(self._client, result)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
) -> EndpointConfigurationList:
|
||||
"""Returns a list of all endpoint configurations on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-list
|
||||
"""
|
||||
path = "/endpoint_configurations"
|
||||
result = self._client.http_client.get(
|
||||
path,
|
||||
dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
),
|
||||
)
|
||||
return EndpointConfigurationList(self._client, result)
|
||||
|
||||
def update(
|
||||
self,
|
||||
id: str,
|
||||
description: str = None,
|
||||
metadata: str = None,
|
||||
circuit_breaker: EndpointCircuitBreaker = None,
|
||||
compression: EndpointCompression = None,
|
||||
request_headers: EndpointRequestHeaders = None,
|
||||
response_headers: EndpointResponseHeaders = None,
|
||||
ip_policy: EndpointIPPolicyMutate = None,
|
||||
mutual_tls: EndpointMutualTLSMutate = None,
|
||||
tls_termination: EndpointTLSTermination = None,
|
||||
webhook_validation: EndpointWebhookValidation = None,
|
||||
oauth: EndpointOAuth = None,
|
||||
logging: EndpointLoggingMutate = None,
|
||||
saml: EndpointSAMLMutate = None,
|
||||
oidc: EndpointOIDC = None,
|
||||
) -> EndpointConfiguration:
|
||||
"""Updates an endpoint configuration. 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.
|
||||
|
||||
:param id: unique identifier of this endpoint configuration
|
||||
:param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
|
||||
:param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
|
||||
:param circuit_breaker: circuit breaker module configuration or ``null``
|
||||
:param compression: compression module configuration or ``null``
|
||||
:param request_headers: request headers module configuration or ``null``
|
||||
:param response_headers: response headers module configuration or ``null``
|
||||
:param ip_policy: ip policy module configuration or ``null``
|
||||
:param mutual_tls: mutual TLS module configuration or ``null``
|
||||
:param tls_termination: TLS termination module configuration or ``null``
|
||||
:param webhook_validation: webhook validation module configuration or ``null``
|
||||
:param oauth: oauth module configuration or ``null``
|
||||
:param logging: logging module configuration or ``null``
|
||||
:param saml: saml module configuration or ``null``
|
||||
:param oidc: oidc module configuration or ``null``
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoint-configurations-update
|
||||
"""
|
||||
path = "/endpoint_configurations/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
result = self._client.http_client.patch(
|
||||
path,
|
||||
dict(
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
circuit_breaker=circuit_breaker,
|
||||
compression=compression,
|
||||
request_headers=request_headers,
|
||||
response_headers=response_headers,
|
||||
ip_policy=ip_policy,
|
||||
mutual_tls=mutual_tls,
|
||||
tls_termination=tls_termination,
|
||||
webhook_validation=webhook_validation,
|
||||
oauth=oauth,
|
||||
logging=logging,
|
||||
saml=saml,
|
||||
oidc=oidc,
|
||||
),
|
||||
)
|
||||
return EndpointConfiguration(self._client, result)
|
||||
|
||||
|
||||
class EndpointLoggingModuleClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
@@ -2035,6 +2300,10 @@ class EndpointOIDCModuleClient(object):
|
||||
|
||||
|
||||
class ReservedAddrsClient(object):
|
||||
"""Reserved Addresses are TCP addresses that can be used to listen for traffic.
|
||||
TCP address hostnames and ports are assigned by ngrok, they cannot be
|
||||
chosen."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -2169,6 +2438,11 @@ class ReservedAddrsClient(object):
|
||||
|
||||
|
||||
class ReservedDomainsClient(object):
|
||||
"""Reserved Domains are hostnames that you can listen for traffic on. Domains
|
||||
can be used to listen for http, https or tls traffic. You may use a domain
|
||||
that you own by creating a CNAME record specified in the returned resource.
|
||||
This CNAME record points traffic for that domain to ngrok's edge servers."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -2178,8 +2452,8 @@ class ReservedDomainsClient(object):
|
||||
region: str = "",
|
||||
description: str = "",
|
||||
metadata: str = "",
|
||||
http_endpoint_configuration_id: str = "",
|
||||
https_endpoint_configuration_id: str = "",
|
||||
http_endpoint_configuration_id: str = None,
|
||||
https_endpoint_configuration_id: str = None,
|
||||
certificate_id: str = None,
|
||||
certificate_management_policy: ReservedDomainCertPolicy = None,
|
||||
) -> ReservedDomain:
|
||||
@@ -2372,6 +2646,9 @@ class ReservedDomainsClient(object):
|
||||
|
||||
|
||||
class SSHCertificateAuthoritiesClient(object):
|
||||
"""An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
||||
key that can be used to sign other SSH host and user certificates."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -2490,6 +2767,9 @@ class SSHCertificateAuthoritiesClient(object):
|
||||
|
||||
|
||||
class SSHCredentialsClient(object):
|
||||
"""SSH Credentials are SSH public keys that can be used to start SSH tunnels
|
||||
via the ngrok SSH tunnel gateway."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -2608,6 +2888,10 @@ class SSHCredentialsClient(object):
|
||||
|
||||
|
||||
class SSHHostCertificatesClient(object):
|
||||
"""SSH Host Certificates along with the corresponding private key allows an SSH
|
||||
server to assert its authenticity to connecting SSH clients who trust the
|
||||
SSH Certificate Authority that was used to sign the certificate."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -2732,6 +3016,10 @@ class SSHHostCertificatesClient(object):
|
||||
|
||||
|
||||
class SSHUserCertificatesClient(object):
|
||||
"""SSH User Certificates are presented by SSH clients when connecting to an SSH
|
||||
server to authenticate their connection. The SSH server must trust the SSH
|
||||
Certificate Authority used to sign the certificate."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -2862,6 +3150,12 @@ class SSHUserCertificatesClient(object):
|
||||
|
||||
|
||||
class TLSCertificatesClient(object):
|
||||
"""TLS Certificates are pairs of x509 certificates and their matching private
|
||||
key that can be used to terminate TLS traffic. TLS certificates are unused
|
||||
until they are attached to a Domain. TLS Certificates may also be
|
||||
provisioned by ngrok automatically for domains on which you have enabled
|
||||
automated certificate provisioning."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
@@ -2977,6 +3271,10 @@ class TLSCertificatesClient(object):
|
||||
|
||||
|
||||
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
|
||||
|
||||
@@ -3069,6 +3367,9 @@ class TunnelSessionsClient(object):
|
||||
|
||||
|
||||
class TunnelsClient(object):
|
||||
"""Tunnels provide endpoints to access services exposed by a running ngrok
|
||||
agent tunnel session or an SSH reverse tunnel session."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ def read_file(filename):
|
||||
|
||||
setup(
|
||||
name="ngrok-api",
|
||||
version="0.1.3",
|
||||
version="0.3.0",
|
||||
description="ngrok HTTP API client library",
|
||||
long_description=read_file("README.md"),
|
||||
long_description_content_type="text/markdown",
|
||||
|
||||
+82
-2
@@ -4,14 +4,22 @@ import json
|
||||
import os
|
||||
from typing import Optional, Mapping, Union, Dict, Any
|
||||
|
||||
def test_certificate_authorities():
|
||||
def setup_api_client():
|
||||
c = ngrok.Client(os.getenv("NGROK_API_KEY"))
|
||||
|
||||
mock = MockHTTPClient()
|
||||
if not os.getenv('TEST_NO_MOCK', False):
|
||||
c.http_client = mock
|
||||
elif os.getenv('TEST_DEBUG', False):
|
||||
c.http_client = RecordingHTTPClient(c.http_client.api_key, c.http_client.base_url)
|
||||
return c, mock
|
||||
|
||||
def test_domains():
|
||||
c, mock = setup_api_client()
|
||||
mock.returns(mock_domains_list)
|
||||
c.reserved_domains.list()
|
||||
|
||||
def test_certificate_authorities():
|
||||
c, mock = setup_api_client()
|
||||
|
||||
mock.returns(mock_empty_ca_list)
|
||||
c.certificate_authorities.list()
|
||||
@@ -95,6 +103,78 @@ mock_ca_list = """
|
||||
{"certificate_authorities": ["""+mock_ca_updated+"""], "uri": "https://api.ngrok.com/certificate_authorities", "next_page_uri": null}
|
||||
"""
|
||||
|
||||
mock_domains_list = """
|
||||
{
|
||||
"next_page_uri": null,
|
||||
"reserved_domains": [
|
||||
{
|
||||
"certificate": {
|
||||
"id": "cert_1x0gxFw5yk5hP9l5CCCeZFJGQYe",
|
||||
"uri": "https://api.ngrok.com/tls_certificates/cert_1x0gxFw5yk5hP9l5CCCeZFJGQYe"
|
||||
},
|
||||
"certificate_management_policy": null,
|
||||
"certificate_management_status": {
|
||||
"provisioning_job": null,
|
||||
"renews_at": "2021-09-27T00:00:00Z"
|
||||
},
|
||||
"cname_target": null,
|
||||
"created_at": "2021-07-29T23:26:04Z",
|
||||
"description": "",
|
||||
"domain": "foo.bar.eu.ngrok.io",
|
||||
"http_endpoint_configuration": null,
|
||||
"https_endpoint_configuration": null,
|
||||
"id": "rd_1y0gxIswrmoFkUNRtcFI7Jp3kxc",
|
||||
"metadata": "",
|
||||
"region": "eu",
|
||||
"uri": "https://api.ngrok.com/reserved_domains/rd_1y0gxIswrmoFkUNRtcFI7Jp3kxc"
|
||||
},
|
||||
{
|
||||
"certificate": null,
|
||||
"certificate_management_policy": null,
|
||||
"certificate_management_status": null,
|
||||
"cname_target": null,
|
||||
"created_at": "2021-08-06T17:52:19Z",
|
||||
"description": "",
|
||||
"domain": "example.sa.ngrok.io",
|
||||
"http_endpoint_configuration": null,
|
||||
"https_endpoint_configuration": {
|
||||
"id": "ec_1gUC0ny5iRymskdQR19d3toQfqm",
|
||||
"uri": "https://api.ngrok.com/endpoint_configurations/ec_1fHC0ny5iRymskdQR19d3toQfqm"
|
||||
},
|
||||
"id": "rd_1P3s6a44QOx89K42NUPV94Jrtqv",
|
||||
"metadata": "",
|
||||
"region": "sa",
|
||||
"uri": "https://api.ngrok.com/reserved_domains/rd_1P3s6a44QOx89K42NUPV94Jrtqv"
|
||||
},
|
||||
{
|
||||
"certificate": {
|
||||
"id": "cert_1wEAwMH75dWjyiceoDA0xw5WY09",
|
||||
"uri": "https://api.ngrok.com/tls_certificates/cert_1wEAwMH75dWjyiceoDA0xw5WY09"
|
||||
},
|
||||
"certificate_management_policy": {
|
||||
"authority": "letsencrypt",
|
||||
"private_key_type": "rsa"
|
||||
},
|
||||
"certificate_management_status": {
|
||||
"provisioning_job": null,
|
||||
"renews_at": "2021-10-02T00:00:00Z"
|
||||
},
|
||||
"cname_target": "gqgmkjdu.cname.ngrok.io",
|
||||
"created_at": "1970-01-01T00:00:00Z",
|
||||
"description": "",
|
||||
"domain": "name.example.com",
|
||||
"http_endpoint_configuration": null,
|
||||
"https_endpoint_configuration": null,
|
||||
"id": "rd_8iLLoZgFuC6mYrgRf5NM",
|
||||
"metadata": "",
|
||||
"region": "us",
|
||||
"uri": "https://api.ngrok.com/reserved_domains/rd_8iLLoZgFuC6mYrgRf5NM"
|
||||
}
|
||||
],
|
||||
"uri": "https://api.ngrok.com/reserved_domains"
|
||||
}
|
||||
"""
|
||||
|
||||
class RecordingHTTPClient(ngrok.http_client.HTTPClient):
|
||||
""" prints all responses received to stdout, useful for creating mocked outputs """
|
||||
def do(self, method: str, path: str, query_params: Mapping[str, str] = None, payload: Mapping[str, Any] = None) -> Optional[Dict[str, Any]]:
|
||||
|
||||
Reference in New Issue
Block a user