mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-11-18 21:23:39 +00:00
Merge pull request #53 from ngrok/pr/generated-4594220931
Update generated files
This commit is contained in:
85 files changed
+1456
-135
No files matched your search
@@ -1,4 +1,7 @@
|
||||
<!-- Code generated for API Clients. DO NOT EDIT. -->
|
||||
## 0.18.0
|
||||
* Add support for CEL filtering when listing resources.
|
||||
|
||||
## 0.17.0
|
||||
* Change endpoint filtering query parameters to `id` and `url`.
|
||||
* Add support for getting secrets by vault.
|
||||
|
||||
@@ -174,6 +174,7 @@ API Reference
|
||||
reserved_addrs
|
||||
reserved_domains
|
||||
secrets
|
||||
service_users
|
||||
ssh_certificate_authorities
|
||||
ssh_credentials
|
||||
ssh_host_certificates
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Service Users
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.service_users` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: ServiceUsersClient
|
||||
:undoc-members: ServiceUsersClient
|
||||
@@ -4,7 +4,7 @@
|
||||
<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" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Overview: module code - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -212,6 +212,7 @@
|
||||
<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="../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../service_users.html">Service Users</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>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<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" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>ngrok.client - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -212,6 +212,7 @@
|
||||
<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="../../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../service_users.html">Service Users</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>
|
||||
@@ -384,6 +385,10 @@
|
||||
<span class="w"> </span><span class="sd">"""Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""</span>
|
||||
<span class="k">return</span> <span class="n">SecretsClient</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="w"> </span><span class="nf">service_users</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">ServiceUsersClient</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">ServiceUsersClient</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="w"> </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="w"> </span><span class="sd">"""An SSH Certificate Authority is a pair of an SSH Certificate and its private</span>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<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" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>ngrok.datatypes - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -212,6 +212,7 @@
|
||||
<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="../../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../service_users.html">Service Users</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>
|
||||
@@ -3941,7 +3942,7 @@
|
||||
<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">bindings</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">pooling_enabled</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
||||
<span class="n">pooling_enabled</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">endpoints</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
@@ -3982,7 +3983,7 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">public_url</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URL of the hostport served by this endpoint"""</span>
|
||||
<span class="w"> </span><span class="sd">"""deprecated [replaced by URL]: URL of the hostport served by this endpoint"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"public_url"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
@@ -5442,7 +5443,12 @@
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">vault</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Ref</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Reference to the vault the secret is stored in"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"vault"</span><span class="p">]</span></div>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"vault"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">vault_name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Name of the vault the secret is stored in"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"vault_name"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SecretList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.SecretList">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">SecretList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
@@ -5482,6 +5488,102 @@
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"next_page_uri"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ServiceUser"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.ServiceUser">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">ServiceUser</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<ServiceUser </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<ServiceUser </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<div class="viewcode-block" id="ServiceUser.delete"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.ServiceUser.delete">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">service_users</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServiceUser.update"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.ServiceUser.update">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">service_users</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="o">=</span><span class="n">active</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""unique API key resource identifier"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"id"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI to the API resource of this service user"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""human-readable name used to identify the service"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">active</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""whether or not the service is active"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"active"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">created_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""timestamp when the api key was created, RFC 3339 format"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"created_at"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ServiceUserList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.ServiceUserList">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">ServiceUserList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"service_users"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="p">[</span><span class="n">ServiceUser</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">"service_users"</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"service_users"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="p">[]</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<ServiceUserList </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<ServiceUserList </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">PagedIterator</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">"service_users"</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">service_users</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="n">ServiceUser</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""the list of all service users on this account"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"service_users"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the service users list API resource"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">next_page_uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the next page, or null if there is no next page"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"next_page_uri"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SSHCertificateAuthority"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.SSHCertificateAuthority">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">SSHCertificateAuthority</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<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" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>ngrok.error - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -212,6 +212,7 @@
|
||||
<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="../../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../service_users.html">Service Users</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>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<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" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>ngrok.services - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -212,6 +212,7 @@
|
||||
<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="../../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../service_users.html">Service Users</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>
|
||||
@@ -381,11 +382,13 @@
|
||||
<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="nb">filter</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">AgentIngressList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all Agent Ingresses owned by this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-agent-ingresses-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -393,6 +396,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">AgentIngressList</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>
|
||||
@@ -498,11 +502,13 @@
|
||||
<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="nb">filter</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">APIKeyList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all API keys owned by this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-api-keys-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -510,6 +516,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">APIKeyList</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>
|
||||
@@ -672,11 +679,13 @@
|
||||
<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="nb">filter</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">TunnelSessionList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all online tunnel sessions running on this account.</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -684,6 +693,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">TunnelSessionList</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>
|
||||
@@ -1506,7 +1516,7 @@
|
||||
<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">CertificateAuthority</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get detailed information about a certficate authority</span>
|
||||
<span class="w"> </span><span class="sd">"""Get detailed information about a certificate authority</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
@@ -1524,11 +1534,13 @@
|
||||
<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="nb">filter</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">CertificateAuthorityList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all Certificate Authority on this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-certificate-authorities-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -1536,6 +1548,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">CertificateAuthorityList</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>
|
||||
@@ -1640,11 +1653,13 @@
|
||||
<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="nb">filter</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">CredentialList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all tunnel authtoken credentials on this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-credentials-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -1652,6 +1667,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">CredentialList</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>
|
||||
@@ -3780,7 +3796,7 @@
|
||||
<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">bindings</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">pooling_enabled</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
||||
<span class="n">pooling_enabled</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Endpoint</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create an endpoint, currently available only for cloud endpoints</span>
|
||||
|
||||
@@ -3813,6 +3829,7 @@
|
||||
<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="nb">id</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="n">url</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="nb">filter</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">EndpointList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all active endpoints on the account</span>
|
||||
|
||||
@@ -3820,6 +3837,7 @@
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param id:</span>
|
||||
<span class="sd"> :param url:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-endpoints-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -3829,6 +3847,7 @@
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</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="n">url</span><span class="o">=</span><span class="n">url</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EndpointList</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>
|
||||
@@ -3859,7 +3878,7 @@
|
||||
<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">bindings</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">pooling_enabled</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
||||
<span class="n">pooling_enabled</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Endpoint</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Update an Endpoint by ID, currently available only for cloud endpoints</span>
|
||||
|
||||
@@ -3975,11 +3994,13 @@
|
||||
<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="nb">filter</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">EventDestinationList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all Event Destinations on this account.</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-destinations-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -3987,6 +4008,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">EventDestinationList</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>
|
||||
@@ -4092,11 +4114,13 @@
|
||||
<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="nb">filter</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="w"> </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"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-event-subscriptions-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -4104,6 +4128,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">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>
|
||||
@@ -4315,11 +4340,13 @@
|
||||
<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="nb">filter</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">IPPolicyList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all IP policies on this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-ip-policies-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -4327,6 +4354,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">IPPolicyList</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>
|
||||
@@ -4432,11 +4460,13 @@
|
||||
<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="nb">filter</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">IPPolicyRuleList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all IP policy rules on this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-ip-policy-rules-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -4444,6 +4474,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">IPPolicyRuleList</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>
|
||||
@@ -4556,11 +4587,13 @@
|
||||
<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="nb">filter</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">IPRestrictionList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all IP restrictions on this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-ip-restrictions-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -4568,6 +4601,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">IPRestrictionList</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>
|
||||
@@ -4674,11 +4708,13 @@
|
||||
<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="nb">filter</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">ReservedAddrList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all reserved addresses on this account.</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-reserved-addrs-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -4686,6 +4722,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">ReservedAddrList</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>
|
||||
@@ -4796,11 +4833,13 @@
|
||||
<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="nb">filter</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">ReservedDomainList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all reserved domains on this account.</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -4808,6 +4847,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">ReservedDomainList</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>
|
||||
@@ -4886,11 +4926,12 @@
|
||||
|
||||
<div class="viewcode-block" id="SecretsClient.create"><a class="viewcode-back" href="../../secrets.html#ngrok.services.SecretsClient.create">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">create</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">vault_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">value</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">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">vault_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">vault_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Secret</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create a new Secret</span>
|
||||
|
||||
@@ -4899,6 +4940,7 @@
|
||||
<span class="sd"> :param metadata: Arbitrary user-defined metadata for this Secret</span>
|
||||
<span class="sd"> :param description: description of Secret</span>
|
||||
<span class="sd"> :param vault_id: unique identifier of the referenced vault</span>
|
||||
<span class="sd"> :param vault_name: name of the referenced vault</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-secrets-create</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -4909,6 +4951,7 @@
|
||||
<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">vault_id</span><span class="o">=</span><span class="n">vault_id</span><span class="p">,</span>
|
||||
<span class="n">vault_name</span><span class="o">=</span><span class="n">vault_name</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Secret</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>
|
||||
@@ -4983,11 +5026,13 @@
|
||||
<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="nb">filter</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">SecretList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all Secrets owned by account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-secrets-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -4995,11 +5040,120 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">SecretList</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="ServiceUsersClient"><a class="viewcode-back" href="../../service_users.html#ngrok.services.ServiceUsersClient">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">ServiceUsersClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span><span class="w"> </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="ServiceUsersClient.create"><a class="viewcode-back" href="../../service_users.html#ngrok.services.ServiceUsersClient.create">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">create</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">ServiceUser</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create a new service user</span>
|
||||
|
||||
<span class="sd"> :param name: human-readable name used to identify the service</span>
|
||||
<span class="sd"> :param active: whether or not the service is active</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-service-users-create</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/service_users"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="o">=</span><span class="n">active</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">ServiceUser</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="ServiceUsersClient.delete"><a class="viewcode-back" href="../../service_users.html#ngrok.services.ServiceUsersClient.delete">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Delete a service user by ID</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-service-users-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/service_users/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServiceUsersClient.get"><a class="viewcode-back" href="../../service_users.html#ngrok.services.ServiceUsersClient.get">[docs]</a> <span class="k">def</span><span class="w"> </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">ServiceUser</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get the details of a Bot User by ID.</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-service-users-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/service_users/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">ServiceUser</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="ServiceUsersClient.list"><a class="viewcode-back" href="../../service_users.html#ngrok.services.ServiceUsersClient.list">[docs]</a> <span class="k">def</span><span class="w"> </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="nb">filter</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">ServiceUserList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all service users in this account.</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-service-users-list</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/service_users"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">ServiceUserList</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="ServiceUsersClient.update"><a class="viewcode-back" href="../../service_users.html#ngrok.services.ServiceUsersClient.update">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">ServiceUser</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Update attributes of a service user by ID.</span>
|
||||
|
||||
<span class="sd"> :param id:</span>
|
||||
<span class="sd"> :param name: human-readable name used to identify the service</span>
|
||||
<span class="sd"> :param active: whether or not the service is active</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-service-users-update</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/service_users/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">active</span><span class="o">=</span><span class="n">active</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">ServiceUser</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="SSHCertificateAuthoritiesClient"><a class="viewcode-back" href="../../ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">SSHCertificateAuthoritiesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="w"> </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>
|
||||
@@ -5057,7 +5211,7 @@
|
||||
<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">SSHCertificateAuthority</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get detailed information about an SSH Certficate Authority</span>
|
||||
<span class="w"> </span><span class="sd">"""Get detailed information about an SSH Certificate Authority</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
@@ -5075,11 +5229,13 @@
|
||||
<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="nb">filter</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">SSHCertificateAuthorityList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all SSH Certificate Authorities on this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-ssh-certificate-authorities-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -5087,6 +5243,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">SSHCertificateAuthorityList</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>
|
||||
@@ -5192,11 +5349,13 @@
|
||||
<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="nb">filter</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">SSHCredentialList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all ssh credentials on this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-ssh-credentials-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -5204,6 +5363,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">SSHCredentialList</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>
|
||||
@@ -5301,7 +5461,7 @@
|
||||
<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">SSHHostCertificate</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get detailed information about an SSH Host Certficate</span>
|
||||
<span class="w"> </span><span class="sd">"""Get detailed information about an SSH Host Certificate</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
@@ -5431,7 +5591,7 @@
|
||||
<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">SSHUserCertificate</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get detailed information about an SSH User Certficate</span>
|
||||
<span class="w"> </span><span class="sd">"""Get detailed information about an SSH User Certificate</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
@@ -5566,11 +5726,13 @@
|
||||
<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="nb">filter</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">TLSCertificateList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all TLS certificates on this account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-tls-certificates-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -5578,6 +5740,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">TLSCertificateList</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>
|
||||
@@ -5775,11 +5938,13 @@
|
||||
<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="nb">filter</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">VaultList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all Vaults owned by account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param filter:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-vaults-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -5787,6 +5952,7 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">VaultList</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>
|
||||
|
||||
@@ -174,6 +174,7 @@ API Reference
|
||||
reserved_addrs
|
||||
reserved_domains
|
||||
secrets
|
||||
service_users
|
||||
ssh_certificate_authorities
|
||||
ssh_credentials
|
||||
ssh_host_certificates
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Service Users
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.service_users` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: ServiceUsersClient
|
||||
:undoc-members: ServiceUsersClient
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Agent Ingresses" href="agent_ingresses.html" /><link rel="prev" title="Errors" href="errors.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Abuse Reports - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="API Keys" href="api_keys.html" /><link rel="prev" title="Abuse Reports" href="abuse_reports.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Agent Ingresses - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -314,13 +315,14 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.AgentIngressesClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#AgentIngressesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.AgentIngressesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#AgentIngressesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.AgentIngressesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all Agent Ingresses owned by this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+4
-2
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Application Sessions" href="application_sessions.html" /><link rel="prev" title="Agent Ingresses" href="agent_ingresses.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>API Keys - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -318,13 +319,14 @@ ngrok.com dashboard.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.APIKeysClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#APIKeysClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.APIKeysClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#APIKeysClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.APIKeysClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all API keys owned by this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Application Users" href="application_users.html" /><link rel="prev" title="API Keys" href="api_keys.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Application Sessions - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Tunnel Sessions" href="tunnel_sessions.html" /><link rel="prev" title="Application Sessions" href="application_sessions.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Application Users - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
+2
-1
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Certificate Authorities" href="certificate_authorities.html" /><link rel="prev" title="Weighted Backends" href="weighted_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Bot Users - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Tunnel Credentials" href="credentials.html" /><link rel="prev" title="Bot Users" href="bot_users.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Certificate Authorities - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -302,7 +303,7 @@ thus a private key is not included in the resource.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.CertificateAuthoritiesClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#CertificateAuthoritiesClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CertificateAuthoritiesClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Get detailed information about a certficate authority</p>
|
||||
<dd><p>Get detailed information about a certificate authority</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
@@ -318,13 +319,14 @@ thus a private key is not included in the resource.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.CertificateAuthoritiesClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#CertificateAuthoritiesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CertificateAuthoritiesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#CertificateAuthoritiesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CertificateAuthoritiesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all Certificate Authority on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+13
-1
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Datatypes" href="datatypes.html" /><link rel="prev" title="ngrok-api" href="index.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Client - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -510,6 +511,16 @@ This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.Client.service_users">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="service_users.html#ngrok.services.ServiceUsersClient" title="ngrok.services.ServiceUsersClient"><span class="pre">ServiceUsersClient</span></a></em><a class="headerlink" href="#ngrok.Client.service_users" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="service_users.html#ngrok.services.ServiceUsersClient" title="ngrok.services.ServiceUsersClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceUsersClient</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.Client.ssh_certificate_authorities">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ssh_certificate_authorities</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient" title="ngrok.services.SSHCertificateAuthoritiesClient"><span class="pre">SSHCertificateAuthoritiesClient</span></a></em><a class="headerlink" href="#ngrok.Client.ssh_certificate_authorities" title="Permalink to this definition">#</a></dt>
|
||||
@@ -693,6 +704,7 @@ agent tunnel session or an SSH reverse tunnel session.</p>
|
||||
<li><a class="reference internal" href="#ngrok.Client.reserved_addrs"><code class="docutils literal notranslate"><span class="pre">Client.reserved_addrs</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.reserved_domains"><code class="docutils literal notranslate"><span class="pre">Client.reserved_domains</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.secrets"><code class="docutils literal notranslate"><span class="pre">Client.secrets</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.service_users"><code class="docutils literal notranslate"><span class="pre">Client.service_users</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.ssh_certificate_authorities"><code class="docutils literal notranslate"><span class="pre">Client.ssh_certificate_authorities</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.ssh_credentials"><code class="docutils literal notranslate"><span class="pre">Client.ssh_credentials</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.ssh_host_certificates"><code class="docutils literal notranslate"><span class="pre">Client.ssh_host_certificates</span></code></a></li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Routes" href="edges_https_routes.html" /><link rel="prev" title="Certificate Authorities" href="certificate_authorities.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Tunnel Credentials - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -318,13 +319,14 @@ configuration file with the <code class="docutils literal notranslate"><span cla
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.CredentialsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#CredentialsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CredentialsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#CredentialsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CredentialsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all tunnel authtoken credentials on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+140
-3
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Errors" href="errors.html" /><link rel="prev" title="Client" href="client.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Datatypes - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -1783,7 +1784,7 @@
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.public_url">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">public_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.public_url" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URL of the hostport served by this endpoint</p>
|
||||
<dd><p>deprecated [replaced by URL]: URL of the hostport served by this endpoint</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
@@ -1869,7 +1870,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</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">traffic_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">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindings</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">pooling_enabled</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/datatypes.html#Endpoint.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Endpoint.update" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</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">traffic_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">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindings</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">pooling_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Endpoint.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Endpoint.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
@@ -6427,6 +6428,17 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.vault_name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">vault_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Secret.vault_name" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Name of the vault the secret is stored in</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
@@ -6466,6 +6478,114 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUser">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">ServiceUser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ServiceUser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ServiceUser" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUser.active">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">active</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#ngrok.datatypes.ServiceUser.active" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>whether or not the service is active</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUser.created_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#ngrok.datatypes.ServiceUser.created_at" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>timestamp when the api key was created, RFC 3339 format</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUser.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ServiceUser.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ServiceUser.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUser.id">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.ServiceUser.id" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>unique API key resource identifier</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUser.name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.ServiceUser.name" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>human-readable name used to identify the service</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUser.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ServiceUser.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ServiceUser.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUser.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.ServiceUser.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI to the API resource of this service user</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUserList">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">ServiceUserList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ServiceUserList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ServiceUserList" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUserList.next_page_uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">next_page_uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.ServiceUserList.next_page_uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUserList.service_users">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ngrok.datatypes.ServiceUser" title="ngrok.datatypes.ServiceUser"><span class="pre">ServiceUser</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.ServiceUserList.service_users" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>the list of all service users on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.ServiceUser" title="ngrok.datatypes.ServiceUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceUser</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.ServiceUserList.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.ServiceUserList.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the service users list API resource</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">StaticBackend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#StaticBackend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.StaticBackend" title="Permalink to this definition">#</a></dt>
|
||||
@@ -8927,6 +9047,7 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.updated_at"><code class="docutils literal notranslate"><span class="pre">Secret.updated_at</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.uri"><code class="docutils literal notranslate"><span class="pre">Secret.uri</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.vault"><code class="docutils literal notranslate"><span class="pre">Secret.vault</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.vault_name"><code class="docutils literal notranslate"><span class="pre">Secret.vault_name</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.SecretList"><code class="docutils literal notranslate"><span class="pre">SecretList</span></code></a><ul>
|
||||
@@ -8935,6 +9056,22 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.SecretList.uri"><code class="docutils literal notranslate"><span class="pre">SecretList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUser"><code class="docutils literal notranslate"><span class="pre">ServiceUser</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUser.active"><code class="docutils literal notranslate"><span class="pre">ServiceUser.active</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUser.created_at"><code class="docutils literal notranslate"><span class="pre">ServiceUser.created_at</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUser.delete"><code class="docutils literal notranslate"><span class="pre">ServiceUser.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUser.id"><code class="docutils literal notranslate"><span class="pre">ServiceUser.id</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUser.name"><code class="docutils literal notranslate"><span class="pre">ServiceUser.name</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUser.update"><code class="docutils literal notranslate"><span class="pre">ServiceUser.update()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUser.uri"><code class="docutils literal notranslate"><span class="pre">ServiceUser.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUserList"><code class="docutils literal notranslate"><span class="pre">ServiceUserList</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUserList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">ServiceUserList.next_page_uri</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUserList.service_users"><code class="docutils literal notranslate"><span class="pre">ServiceUserList.service_users</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.ServiceUserList.uri"><code class="docutils literal notranslate"><span class="pre">ServiceUserList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend"><code class="docutils literal notranslate"><span class="pre">StaticBackend</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.address"><code class="docutils literal notranslate"><span class="pre">StaticBackend.address</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.created_at"><code class="docutils literal notranslate"><span class="pre">StaticBackend.created_at</span></code></a></li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route IP Restriction Module" href="edge_route_ip_restriction_module.html" /><link rel="prev" title="HTTPS Edge TLS Termination Module" href="https_edge_tls_termination_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Backend Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route Webhook Verification Module" href="edge_route_webhook_verification_module.html" /><link rel="prev" title="HTTPS Edge Route Compression Module" href="edge_route_compression_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Circuit Breaker Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route Circuit Breaker Module" href="edge_route_circuit_breaker_module.html" /><link rel="prev" title="HTTPS Edge Route Response Headers Module" href="edge_route_response_headers_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Compression Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route Request Headers Module" href="edge_route_request_headers_module.html" /><link rel="prev" title="HTTPS Edge Route Backend Module" href="edge_route_backend_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route IP Restriction Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route SAML Module" href="edge_route_saml_module.html" /><link rel="prev" title="HTTPS Edge Route Webhook Verification Module" href="edge_route_webhook_verification_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route OAuth Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route Websocket TCP Converter Module" href="edge_route_websocket_tcp_converter_module.html" /><link rel="prev" title="HTTPS Edge Route SAML Module" href="edge_route_saml_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route OIDC Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Policies Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route Response Headers Module" href="edge_route_response_headers_module.html" /><link rel="prev" title="HTTPS Edge Route IP Restriction Module" href="edge_route_ip_restriction_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Request Headers Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route Compression Module" href="edge_route_compression_module.html" /><link rel="prev" title="HTTPS Edge Route Request Headers Module" href="edge_route_request_headers_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Response Headers Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route OIDC Module" href="edge_route_oidc_module.html" /><link rel="prev" title="HTTPS Edge Route OAuth Module" href="edge_route_o_auth_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route SAML Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TCP Edges" href="edges_tcp.html" /><link rel="prev" title="HTTPS Edge Route User Agent Filter Module" href="edge_route_user_agent_filter_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Traffic Policy Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route Traffic Policy Module" href="edge_route_traffic_policy_module.html" /><link rel="prev" title="HTTPS Edge Route Websocket TCP Converter Module" href="edge_route_websocket_tcp_converter_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route User Agent Filter Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route OAuth Module" href="edge_route_o_auth_module.html" /><link rel="prev" title="HTTPS Edge Route Circuit Breaker Module" href="edge_route_circuit_breaker_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Webhook Verification Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route User Agent Filter Module" href="edge_route_user_agent_filter_module.html" /><link rel="prev" title="HTTPS Edge Route OIDC Module" href="edge_route_oidc_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Route Websocket TCP Converter Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Mutual TLS Module" href="https_edge_mutual_tls_module.html" /><link rel="prev" title="HTTPS Edge Routes" href="edges_https_routes.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edges - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edges" href="edges_https.html" /><link rel="prev" title="Tunnel Credentials" href="credentials.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Routes - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
+2
-1
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TCP Edge Backend Module" href="tcp_edge_backend_module.html" /><link rel="prev" title="HTTPS Edge Route Traffic Policy Module" href="edge_route_traffic_policy_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TCP Edges - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
+2
-1
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edge Backend Module" href="tls_edge_backend_module.html" /><link rel="prev" title="TCP Edge Traffic Policy Module" href="tcp_edge_traffic_policy_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TLS Edges - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
+6
-4
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Destinations" href="event_destinations.html" /><link rel="prev" title="TLS Edge Traffic Policy Module" href="tls_edge_traffic_policy_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Endpoints - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -266,7 +267,7 @@ which define what tunnel or edge is used to serve a hostport.
|
||||
Only active endpoints associated with a tunnel or backend are returned.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EndpointsClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">traffic_policy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindings</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">pooling_enabled</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#EndpointsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">traffic_policy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindings</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">pooling_enabled</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#EndpointsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create an endpoint, currently available only for cloud endpoints</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
@@ -320,7 +321,7 @@ Only active endpoints associated with a tunnel or backend are returned.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EndpointsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">url</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#EndpointsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">url</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">filter</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#EndpointsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all active endpoints on the account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
@@ -329,6 +330,7 @@ Only active endpoints associated with a tunnel or backend are returned.</p>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
|
||||
<li><p><strong>url</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>]) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -342,7 +344,7 @@ Only active endpoints associated with a tunnel or backend are returned.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EndpointsClient.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</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">traffic_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">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindings</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">pooling_enabled</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#EndpointsClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</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">traffic_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">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindings</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">pooling_enabled</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#EndpointsClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Update an Endpoint by ID, currently available only for cloud endpoints</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
|
||||
+2
-1
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Abuse Reports" href="abuse_reports.html" /><link rel="prev" title="Datatypes" href="datatypes.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Errors - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Subscriptions" href="event_subscriptions.html" /><link rel="prev" title="Endpoints" href="endpoints.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Event Destinations - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -314,13 +315,14 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EventDestinationsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EventDestinationsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventDestinationsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#EventDestinationsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventDestinationsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all Event Destinations on this account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="IP Policies" href="ip_policies.html" /><link rel="prev" title="Event Subscriptions" href="event_subscriptions.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Event Sources - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Event Sources" href="event_sources.html" /><link rel="prev" title="Event Destinations" href="event_destinations.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Event Subscriptions - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -314,13 +315,14 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EventSubscriptionsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#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>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTP Response Backends" href="http_response_backends.html" /><link rel="prev" title="Tunnel Sessions" href="tunnel_sessions.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Failover Backends - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
+54
-9
@@ -4,7 +4,7 @@
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 --><title>Index - ngrok-api documentation</title>
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 --><title>Index - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
@@ -211,6 +211,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -279,7 +280,11 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicyRule.action">action (ngrok.datatypes.IPPolicyRule property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BotUser.active">active (ngrok.datatypes.BotUser property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUser.active">(ngrok.datatypes.ServiceUser property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders.add">add (ngrok.datatypes.EndpointRequestHeaders property)</a>
|
||||
|
||||
<ul>
|
||||
@@ -319,11 +324,11 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventTargetDatadog.api_key">api_key (ngrok.datatypes.EventTargetDatadog property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.api_keys">api_keys (ngrok.Client property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey">APIKey (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey">APIKey (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKeyList">APIKeyList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="api_keys.html#ngrok.services.APIKeysClient">APIKeysClient (class in ngrok.services)</a>
|
||||
@@ -616,6 +621,8 @@
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.create">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.create">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="service_users.html#ngrok.services.ServiceUsersClient.create">(ngrok.services.ServiceUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.create">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -680,6 +687,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.created_at">(ngrok.datatypes.ReservedDomain property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.created_at">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUser.created_at">(ngrok.datatypes.ServiceUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.created_at">(ngrok.datatypes.SSHCertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -786,6 +795,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.delete">(ngrok.datatypes.ReservedDomain method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.delete">(ngrok.datatypes.Secret method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUser.delete">(ngrok.datatypes.ServiceUser method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.delete">(ngrok.datatypes.SSHCertificateAuthority method)</a>
|
||||
</li>
|
||||
@@ -884,6 +895,8 @@
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.delete">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.delete">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="service_users.html#ngrok.services.ServiceUsersClient.delete">(ngrok.services.ServiceUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.delete">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -1402,6 +1415,8 @@
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.get">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.get">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="service_users.html#ngrok.services.ServiceUsersClient.get">(ngrok.services.ServiceUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.get">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -1550,6 +1565,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.id">(ngrok.datatypes.ReservedDomain property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.id">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUser.id">(ngrok.datatypes.ServiceUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.id">(ngrok.datatypes.SSHCertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -1578,10 +1595,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackend.id">(ngrok.datatypes.WeightedBackend property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.identity_provider">identity_provider (ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.identity_provider">identity_provider (ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider">IdentityProvider (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.idp_metadata">idp_metadata (ngrok.datatypes.EndpointSAML property)</a>
|
||||
@@ -1772,6 +1789,8 @@
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.list">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.list">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="service_users.html#ngrok.services.ServiceUsersClient.list">(ngrok.services.ServiceUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.list">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -1914,7 +1933,7 @@
|
||||
</li>
|
||||
<li><a href="datatypes.html#module-ngrok.datatypes">ngrok.datatypes</a>
|
||||
</li>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">ngrok.services</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_traffic_policy_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[20]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[21]</a>, <a href="edges_https.html#module-ngrok.services">[22]</a>, <a href="edges_https_routes.html#module-ngrok.services">[23]</a>, <a href="edges_tcp.html#module-ngrok.services">[24]</a>, <a href="edges_tls.html#module-ngrok.services">[25]</a>, <a href="endpoints.html#module-ngrok.services">[26]</a>, <a href="event_destinations.html#module-ngrok.services">[27]</a>, <a href="event_sources.html#module-ngrok.services">[28]</a>, <a href="event_subscriptions.html#module-ngrok.services">[29]</a>, <a href="failover_backends.html#module-ngrok.services">[30]</a>, <a href="http_response_backends.html#module-ngrok.services">[31]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[32]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[33]</a>, <a href="ip_policies.html#module-ngrok.services">[34]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[35]</a>, <a href="ip_restrictions.html#module-ngrok.services">[36]</a>, <a href="reserved_addrs.html#module-ngrok.services">[37]</a>, <a href="reserved_domains.html#module-ngrok.services">[38]</a>, <a href="secrets.html#module-ngrok.services">[39]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[40]</a>, <a href="ssh_credentials.html#module-ngrok.services">[41]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[42]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[43]</a>, <a href="static_backends.html#module-ngrok.services">[44]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[45]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[46]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[47]</a>, <a href="tcp_edge_traffic_policy_module.html#module-ngrok.services">[48]</a>, <a href="tls_certificates.html#module-ngrok.services">[49]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[50]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[51]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[52]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[53]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[54]</a>, <a href="tls_edge_traffic_policy_module.html#module-ngrok.services">[55]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[56]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[57]</a>, <a href="tunnels.html#module-ngrok.services">[58]</a>, <a href="vaults.html#module-ngrok.services">[59]</a>, <a href="weighted_backends.html#module-ngrok.services">[60]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">ngrok.services</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_traffic_policy_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[20]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[21]</a>, <a href="edges_https.html#module-ngrok.services">[22]</a>, <a href="edges_https_routes.html#module-ngrok.services">[23]</a>, <a href="edges_tcp.html#module-ngrok.services">[24]</a>, <a href="edges_tls.html#module-ngrok.services">[25]</a>, <a href="endpoints.html#module-ngrok.services">[26]</a>, <a href="event_destinations.html#module-ngrok.services">[27]</a>, <a href="event_sources.html#module-ngrok.services">[28]</a>, <a href="event_subscriptions.html#module-ngrok.services">[29]</a>, <a href="failover_backends.html#module-ngrok.services">[30]</a>, <a href="http_response_backends.html#module-ngrok.services">[31]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[32]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[33]</a>, <a href="ip_policies.html#module-ngrok.services">[34]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[35]</a>, <a href="ip_restrictions.html#module-ngrok.services">[36]</a>, <a href="reserved_addrs.html#module-ngrok.services">[37]</a>, <a href="reserved_domains.html#module-ngrok.services">[38]</a>, <a href="secrets.html#module-ngrok.services">[39]</a>, <a href="service_users.html#module-ngrok.services">[40]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[41]</a>, <a href="ssh_credentials.html#module-ngrok.services">[42]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[43]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[44]</a>, <a href="static_backends.html#module-ngrok.services">[45]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[46]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[47]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[48]</a>, <a href="tcp_edge_traffic_policy_module.html#module-ngrok.services">[49]</a>, <a href="tls_certificates.html#module-ngrok.services">[50]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[51]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[52]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[53]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[54]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[55]</a>, <a href="tls_edge_traffic_policy_module.html#module-ngrok.services">[56]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[57]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[58]</a>, <a href="tunnels.html#module-ngrok.services">[59]</a>, <a href="vaults.html#module-ngrok.services">[60]</a>, <a href="weighted_backends.html#module-ngrok.services">[61]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AgentIngressCertJob.msg">msg (ngrok.datatypes.AgentIngressCertJob property)</a>
|
||||
@@ -1947,6 +1966,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider.name">(ngrok.datatypes.IdentityProvider property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.name">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUser.name">(ngrok.datatypes.ServiceUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.name">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
@@ -1995,6 +2016,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomainList.next_page_uri">(ngrok.datatypes.ReservedDomainList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SecretList.next_page_uri">(ngrok.datatypes.SecretList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUserList.next_page_uri">(ngrok.datatypes.ServiceUserList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthorityList.next_page_uri">(ngrok.datatypes.SSHCertificateAuthorityList property)</a>
|
||||
</li>
|
||||
@@ -2043,7 +2066,7 @@
|
||||
ngrok.services
|
||||
|
||||
<ul>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_traffic_policy_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[20]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[21]</a>, <a href="edges_https.html#module-ngrok.services">[22]</a>, <a href="edges_https_routes.html#module-ngrok.services">[23]</a>, <a href="edges_tcp.html#module-ngrok.services">[24]</a>, <a href="edges_tls.html#module-ngrok.services">[25]</a>, <a href="endpoints.html#module-ngrok.services">[26]</a>, <a href="event_destinations.html#module-ngrok.services">[27]</a>, <a href="event_sources.html#module-ngrok.services">[28]</a>, <a href="event_subscriptions.html#module-ngrok.services">[29]</a>, <a href="failover_backends.html#module-ngrok.services">[30]</a>, <a href="http_response_backends.html#module-ngrok.services">[31]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[32]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[33]</a>, <a href="ip_policies.html#module-ngrok.services">[34]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[35]</a>, <a href="ip_restrictions.html#module-ngrok.services">[36]</a>, <a href="reserved_addrs.html#module-ngrok.services">[37]</a>, <a href="reserved_domains.html#module-ngrok.services">[38]</a>, <a href="secrets.html#module-ngrok.services">[39]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[40]</a>, <a href="ssh_credentials.html#module-ngrok.services">[41]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[42]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[43]</a>, <a href="static_backends.html#module-ngrok.services">[44]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[45]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[46]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[47]</a>, <a href="tcp_edge_traffic_policy_module.html#module-ngrok.services">[48]</a>, <a href="tls_certificates.html#module-ngrok.services">[49]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[50]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[51]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[52]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[53]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[54]</a>, <a href="tls_edge_traffic_policy_module.html#module-ngrok.services">[55]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[56]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[57]</a>, <a href="tunnels.html#module-ngrok.services">[58]</a>, <a href="vaults.html#module-ngrok.services">[59]</a>, <a href="weighted_backends.html#module-ngrok.services">[60]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_traffic_policy_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[20]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[21]</a>, <a href="edges_https.html#module-ngrok.services">[22]</a>, <a href="edges_https_routes.html#module-ngrok.services">[23]</a>, <a href="edges_tcp.html#module-ngrok.services">[24]</a>, <a href="edges_tls.html#module-ngrok.services">[25]</a>, <a href="endpoints.html#module-ngrok.services">[26]</a>, <a href="event_destinations.html#module-ngrok.services">[27]</a>, <a href="event_sources.html#module-ngrok.services">[28]</a>, <a href="event_subscriptions.html#module-ngrok.services">[29]</a>, <a href="failover_backends.html#module-ngrok.services">[30]</a>, <a href="http_response_backends.html#module-ngrok.services">[31]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[32]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[33]</a>, <a href="ip_policies.html#module-ngrok.services">[34]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[35]</a>, <a href="ip_restrictions.html#module-ngrok.services">[36]</a>, <a href="reserved_addrs.html#module-ngrok.services">[37]</a>, <a href="reserved_domains.html#module-ngrok.services">[38]</a>, <a href="secrets.html#module-ngrok.services">[39]</a>, <a href="service_users.html#module-ngrok.services">[40]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[41]</a>, <a href="ssh_credentials.html#module-ngrok.services">[42]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[43]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[44]</a>, <a href="static_backends.html#module-ngrok.services">[45]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[46]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[47]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[48]</a>, <a href="tcp_edge_traffic_policy_module.html#module-ngrok.services">[49]</a>, <a href="tls_certificates.html#module-ngrok.services">[50]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[51]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[52]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[53]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[54]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[55]</a>, <a href="tls_edge_traffic_policy_module.html#module-ngrok.services">[56]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[57]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[58]</a>, <a href="tunnels.html#module-ngrok.services">[59]</a>, <a href="vaults.html#module-ngrok.services">[60]</a>, <a href="weighted_backends.html#module-ngrok.services">[61]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.not_after">not_after (ngrok.datatypes.CertificateAuthority property)</a>
|
||||
@@ -2365,6 +2388,18 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TLSCertificate.serial_number">serial_number (ngrok.datatypes.TLSCertificate property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventTargetDatadog.service">service (ngrok.datatypes.EventTargetDatadog property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.service_users">service_users (ngrok.Client property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUserList.service_users">(ngrok.datatypes.ServiceUserList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUser">ServiceUser (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUserList">ServiceUserList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="service_users.html#ngrok.services.ServiceUsersClient">ServiceUsersClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.single_logout_url">single_logout_url (ngrok.datatypes.EndpointSAML property)</a>
|
||||
</li>
|
||||
@@ -2398,14 +2433,14 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificateList.ssh_host_certificates">(ngrok.datatypes.SSHHostCertificateList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="client.html#ngrok.Client.ssh_user_certificates">ssh_user_certificates (ngrok.Client property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificateList.ssh_user_certificates">(ngrok.datatypes.SSHUserCertificateList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<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>
|
||||
@@ -2652,6 +2687,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicy.update">(ngrok.datatypes.IPPolicy method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IPPolicyRule.update">(ngrok.datatypes.IPPolicyRule method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUser.update">(ngrok.datatypes.ServiceUser method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.update">(ngrok.datatypes.SSHCertificateAuthority method)</a>
|
||||
</li>
|
||||
@@ -2716,6 +2753,8 @@
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.update">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.update">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="service_users.html#ngrok.services.ServiceUsersClient.update">(ngrok.services.ServiceUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.update">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -2836,6 +2875,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.uri">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SecretList.uri">(ngrok.datatypes.SecretList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUser.uri">(ngrok.datatypes.ServiceUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ServiceUserList.uri">(ngrok.datatypes.ServiceUserList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.uri">(ngrok.datatypes.SSHCertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -2933,6 +2976,8 @@
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.vault">vault (ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.vault_name">vault_name (ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.VaultList">VaultList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Static Backends" href="static_backends.html" /><link rel="prev" title="Failover Backends" href="failover_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTP Response Backends - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge TLS Termination Module" href="https_edge_tls_termination_module.html" /><link rel="prev" title="HTTPS Edges" href="edges_https.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge Mutual TLS Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="HTTPS Edge Route Backend Module" href="edge_route_backend_module.html" /><link rel="prev" title="HTTPS Edge Mutual TLS Module" href="https_edge_mutual_tls_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>HTTPS Edge TLS Termination Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
+31
-1
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Client" href="client.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -377,6 +378,7 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.reserved_addrs"><code class="docutils literal notranslate"><span class="pre">Client.reserved_addrs</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.reserved_domains"><code class="docutils literal notranslate"><span class="pre">Client.reserved_domains</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.secrets"><code class="docutils literal notranslate"><span class="pre">Client.secrets</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.service_users"><code class="docutils literal notranslate"><span class="pre">Client.service_users</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.ssh_certificate_authorities"><code class="docutils literal notranslate"><span class="pre">Client.ssh_certificate_authorities</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.ssh_credentials"><code class="docutils literal notranslate"><span class="pre">Client.ssh_credentials</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.ssh_host_certificates"><code class="docutils literal notranslate"><span class="pre">Client.ssh_host_certificates</span></code></a></li>
|
||||
@@ -1226,6 +1228,7 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.updated_at"><code class="docutils literal notranslate"><span class="pre">Secret.updated_at</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.uri"><code class="docutils literal notranslate"><span class="pre">Secret.uri</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.vault"><code class="docutils literal notranslate"><span class="pre">Secret.vault</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.vault_name"><code class="docutils literal notranslate"><span class="pre">Secret.vault_name</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.SecretList"><code class="docutils literal notranslate"><span class="pre">SecretList</span></code></a><ul>
|
||||
@@ -1234,6 +1237,22 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.SecretList.uri"><code class="docutils literal notranslate"><span class="pre">SecretList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser"><code class="docutils literal notranslate"><span class="pre">ServiceUser</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser.active"><code class="docutils literal notranslate"><span class="pre">ServiceUser.active</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser.created_at"><code class="docutils literal notranslate"><span class="pre">ServiceUser.created_at</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser.delete"><code class="docutils literal notranslate"><span class="pre">ServiceUser.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser.id"><code class="docutils literal notranslate"><span class="pre">ServiceUser.id</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser.name"><code class="docutils literal notranslate"><span class="pre">ServiceUser.name</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser.update"><code class="docutils literal notranslate"><span class="pre">ServiceUser.update()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser.uri"><code class="docutils literal notranslate"><span class="pre">ServiceUser.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUserList"><code class="docutils literal notranslate"><span class="pre">ServiceUserList</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUserList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">ServiceUserList.next_page_uri</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUserList.service_users"><code class="docutils literal notranslate"><span class="pre">ServiceUserList.service_users</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUserList.uri"><code class="docutils literal notranslate"><span class="pre">ServiceUserList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend"><code class="docutils literal notranslate"><span class="pre">StaticBackend</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.address"><code class="docutils literal notranslate"><span class="pre">StaticBackend.address</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.created_at"><code class="docutils literal notranslate"><span class="pre">StaticBackend.created_at</span></code></a></li>
|
||||
@@ -1966,6 +1985,17 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="service_users.html#ngrok.services.ServiceUsersClient"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="service_users.html#ngrok.services.ServiceUsersClient.create"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.create()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="service_users.html#ngrok.services.ServiceUsersClient.delete"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="service_users.html#ngrok.services.ServiceUsersClient.get"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.get()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="service_users.html#ngrok.services.ServiceUsersClient.list"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.list()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="service_users.html#ngrok.services.ServiceUsersClient.update"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient"><code class="docutils literal notranslate"><span class="pre">SSHCertificateAuthoritiesClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.create"><code class="docutils literal notranslate"><span class="pre">SSHCertificateAuthoritiesClient.create()</span></code></a></li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="IP Policy Rules" href="ip_policy_rules.html" /><link rel="prev" title="Event Sources" href="event_sources.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>IP Policies - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -316,13 +317,14 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.</
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.IPPoliciesClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#IPPoliciesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPPoliciesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#IPPoliciesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPPoliciesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all IP policies on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="IP Restrictions" href="ip_restrictions.html" /><link rel="prev" title="IP Policies" href="ip_policies.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>IP Policy Rules - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -317,13 +318,14 @@ make up an IP Policy.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.IPPolicyRulesClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#IPPolicyRulesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPPolicyRulesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#IPPolicyRulesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPPolicyRulesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all IP policy rules on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Reserved Addresses" href="reserved_addrs.html" /><link rel="prev" title="IP Policy Rules" href="ip_policy_rules.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>IP Restrictions - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -321,13 +322,14 @@ public-facing endpoints.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.IPRestrictionsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#IPRestrictionsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPRestrictionsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#IPRestrictionsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.IPRestrictionsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all IP restrictions on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
Binary file not shown.
@@ -4,7 +4,7 @@
|
||||
<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" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 --><title>Python Module Index - ngrok-api documentation</title>
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 --><title>Python Module Index - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
@@ -211,6 +211,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Reserved Domains" href="reserved_domains.html" /><link rel="prev" title="IP Restrictions" href="ip_restrictions.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Reserved Addresses - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -316,13 +317,14 @@ chosen.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.ReservedAddrsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ReservedAddrsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedAddrsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#ReservedAddrsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedAddrsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all reserved addresses on this account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Secrets" href="secrets.html" /><link rel="prev" title="Reserved Addresses" href="reserved_addrs.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Reserved Domains - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -344,13 +345,14 @@ This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.ReservedDomainsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ReservedDomainsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedDomainsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedDomainsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all reserved domains on this account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+2
-1
@@ -4,7 +4,7 @@
|
||||
<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="#" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 --><title>Search - ngrok-api documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 --><title>Search - ngrok-api documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
@@ -210,6 +210,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
+1
-1
@@ -1 +1 @@
|
||||
Search.setIndex({"docnames": ["abuse_reports", "agent_ingresses", "api_keys", "application_sessions", "application_users", "bot_users", "certificate_authorities", "client", "credentials", "datatypes", "edge_route_backend_module", "edge_route_circuit_breaker_module", "edge_route_compression_module", "edge_route_ip_restriction_module", "edge_route_o_auth_module", "edge_route_oidc_module", "edge_route_policy_module", "edge_route_request_headers_module", "edge_route_response_headers_module", "edge_route_saml_module", "edge_route_traffic_policy_module", "edge_route_user_agent_filter_module", "edge_route_webhook_verification_module", "edge_route_websocket_tcp_converter_module", "edges_https", "edges_https_routes", "edges_tcp", "edges_tls", "endpoints", "errors", "event_destinations", "event_sources", "event_subscriptions", "failover_backends", "http_response_backends", "https_edge_mutual_tls_module", "https_edge_tls_termination_module", "index", "ip_policies", "ip_policy_rules", "ip_restrictions", "reserved_addrs", "reserved_domains", "secrets", "ssh_certificate_authorities", "ssh_credentials", "ssh_host_certificates", "ssh_user_certificates", "static_backends", "tcp_edge_backend_module", "tcp_edge_ip_restriction_module", "tcp_edge_policy_module", "tcp_edge_traffic_policy_module", "tls_certificates", "tls_edge_backend_module", "tls_edge_ip_restriction_module", "tls_edge_mutual_tls_module", "tls_edge_policy_module", "tls_edge_tls_termination_module", "tls_edge_traffic_policy_module", "tunnel_group_backends", "tunnel_sessions", "tunnels", "vaults", "weighted_backends"], "filenames": ["abuse_reports.rst", "agent_ingresses.rst", "api_keys.rst", "application_sessions.rst", "application_users.rst", "bot_users.rst", "certificate_authorities.rst", "client.rst", "credentials.rst", "datatypes.rst", "edge_route_backend_module.rst", "edge_route_circuit_breaker_module.rst", "edge_route_compression_module.rst", "edge_route_ip_restriction_module.rst", "edge_route_o_auth_module.rst", "edge_route_oidc_module.rst", "edge_route_policy_module.rst", "edge_route_request_headers_module.rst", "edge_route_response_headers_module.rst", "edge_route_saml_module.rst", "edge_route_traffic_policy_module.rst", "edge_route_user_agent_filter_module.rst", "edge_route_webhook_verification_module.rst", "edge_route_websocket_tcp_converter_module.rst", "edges_https.rst", "edges_https_routes.rst", "edges_tcp.rst", "edges_tls.rst", "endpoints.rst", "errors.rst", "event_destinations.rst", "event_sources.rst", "event_subscriptions.rst", "failover_backends.rst", "http_response_backends.rst", "https_edge_mutual_tls_module.rst", "https_edge_tls_termination_module.rst", "index.rst", "ip_policies.rst", "ip_policy_rules.rst", "ip_restrictions.rst", "reserved_addrs.rst", "reserved_domains.rst", "secrets.rst", "ssh_certificate_authorities.rst", "ssh_credentials.rst", "ssh_host_certificates.rst", "ssh_user_certificates.rst", "static_backends.rst", "tcp_edge_backend_module.rst", "tcp_edge_ip_restriction_module.rst", "tcp_edge_policy_module.rst", "tcp_edge_traffic_policy_module.rst", "tls_certificates.rst", "tls_edge_backend_module.rst", "tls_edge_ip_restriction_module.rst", "tls_edge_mutual_tls_module.rst", "tls_edge_policy_module.rst", "tls_edge_tls_termination_module.rst", "tls_edge_traffic_policy_module.rst", "tunnel_group_backends.rst", "tunnel_sessions.rst", "tunnels.rst", "vaults.rst", "weighted_backends.rst"], "titles": ["Abuse Reports", "Agent Ingresses", "API Keys", "Application Sessions", "Application Users", "Bot Users", "Certificate Authorities", "Client", "Tunnel Credentials", "Datatypes", "HTTPS Edge Route Backend Module", "HTTPS Edge Route Circuit Breaker Module", "HTTPS Edge Route Compression Module", "HTTPS Edge Route IP Restriction Module", "HTTPS Edge Route OAuth Module", "HTTPS Edge Route OIDC Module", "HTTPS Edge Route Policies Module", "HTTPS Edge Route Request Headers Module", "HTTPS Edge Route Response Headers Module", "HTTPS Edge Route SAML Module", "HTTPS Edge Route Traffic Policy Module", "HTTPS Edge Route User Agent Filter Module", "HTTPS Edge Route Webhook Verification Module", "HTTPS Edge Route Websocket TCP Converter Module", "HTTPS Edges", "HTTPS Edge Routes", "TCP Edges", "TLS Edges", "Endpoints", "Errors", "Event Destinations", "Event Sources", "Event Subscriptions", "Failover Backends", "HTTP Response Backends", "HTTPS Edge Mutual TLS Module", "HTTPS Edge TLS Termination Module", "ngrok-api", "IP Policies", "IP Policy Rules", "IP Restrictions", "Reserved Addresses", "Reserved Domains", "Secrets", "SSH Certificate Authorities", "SSH Credentials", "SSH Host Certificates", "SSH User Certificates", "Static Backends", "TCP Edge Backend Module", "TCP Edge IP Restriction Module", "TCP Edge Policy Module", "TCP Edge Traffic Policy Module", "TLS Certificates", "TLS Edge Backend Module", "TLS Edge IP Restriction Module", "TLS Edge Mutual TLS Module", "TLS Edge Policy Module", "TLS Edge TLS Termination Module", "TLS Edge Traffic Policy ModuLine truncated
|
||||
Search.setIndex({"docnames": ["abuse_reports", "agent_ingresses", "api_keys", "application_sessions", "application_users", "bot_users", "certificate_authorities", "client", "credentials", "datatypes", "edge_route_backend_module", "edge_route_circuit_breaker_module", "edge_route_compression_module", "edge_route_ip_restriction_module", "edge_route_o_auth_module", "edge_route_oidc_module", "edge_route_policy_module", "edge_route_request_headers_module", "edge_route_response_headers_module", "edge_route_saml_module", "edge_route_traffic_policy_module", "edge_route_user_agent_filter_module", "edge_route_webhook_verification_module", "edge_route_websocket_tcp_converter_module", "edges_https", "edges_https_routes", "edges_tcp", "edges_tls", "endpoints", "errors", "event_destinations", "event_sources", "event_subscriptions", "failover_backends", "http_response_backends", "https_edge_mutual_tls_module", "https_edge_tls_termination_module", "index", "ip_policies", "ip_policy_rules", "ip_restrictions", "reserved_addrs", "reserved_domains", "secrets", "service_users", "ssh_certificate_authorities", "ssh_credentials", "ssh_host_certificates", "ssh_user_certificates", "static_backends", "tcp_edge_backend_module", "tcp_edge_ip_restriction_module", "tcp_edge_policy_module", "tcp_edge_traffic_policy_module", "tls_certificates", "tls_edge_backend_module", "tls_edge_ip_restriction_module", "tls_edge_mutual_tls_module", "tls_edge_policy_module", "tls_edge_tls_termination_module", "tls_edge_traffic_policy_module", "tunnel_group_backends", "tunnel_sessions", "tunnels", "vaults", "weighted_backends"], "filenames": ["abuse_reports.rst", "agent_ingresses.rst", "api_keys.rst", "application_sessions.rst", "application_users.rst", "bot_users.rst", "certificate_authorities.rst", "client.rst", "credentials.rst", "datatypes.rst", "edge_route_backend_module.rst", "edge_route_circuit_breaker_module.rst", "edge_route_compression_module.rst", "edge_route_ip_restriction_module.rst", "edge_route_o_auth_module.rst", "edge_route_oidc_module.rst", "edge_route_policy_module.rst", "edge_route_request_headers_module.rst", "edge_route_response_headers_module.rst", "edge_route_saml_module.rst", "edge_route_traffic_policy_module.rst", "edge_route_user_agent_filter_module.rst", "edge_route_webhook_verification_module.rst", "edge_route_websocket_tcp_converter_module.rst", "edges_https.rst", "edges_https_routes.rst", "edges_tcp.rst", "edges_tls.rst", "endpoints.rst", "errors.rst", "event_destinations.rst", "event_sources.rst", "event_subscriptions.rst", "failover_backends.rst", "http_response_backends.rst", "https_edge_mutual_tls_module.rst", "https_edge_tls_termination_module.rst", "index.rst", "ip_policies.rst", "ip_policy_rules.rst", "ip_restrictions.rst", "reserved_addrs.rst", "reserved_domains.rst", "secrets.rst", "service_users.rst", "ssh_certificate_authorities.rst", "ssh_credentials.rst", "ssh_host_certificates.rst", "ssh_user_certificates.rst", "static_backends.rst", "tcp_edge_backend_module.rst", "tcp_edge_ip_restriction_module.rst", "tcp_edge_policy_module.rst", "tcp_edge_traffic_policy_module.rst", "tls_certificates.rst", "tls_edge_backend_module.rst", "tls_edge_ip_restriction_module.rst", "tls_edge_mutual_tls_module.rst", "tls_edge_policy_module.rst", "tls_edge_tls_termination_module.rst", "tls_edge_traffic_policy_module.rst", "tunnel_group_backends.rst", "tunnel_sessions.rst", "tunnels.rst", "vaults.rst", "weighted_backends.rst"], "titles": ["Abuse Reports", "Agent Ingresses", "API Keys", "Application Sessions", "Application Users", "Bot Users", "Certificate Authorities", "Client", "Tunnel Credentials", "Datatypes", "HTTPS Edge Route Backend Module", "HTTPS Edge Route Circuit Breaker Module", "HTTPS Edge Route Compression Module", "HTTPS Edge Route IP Restriction Module", "HTTPS Edge Route OAuth Module", "HTTPS Edge Route OIDC Module", "HTTPS Edge Route Policies Module", "HTTPS Edge Route Request Headers Module", "HTTPS Edge Route Response Headers Module", "HTTPS Edge Route SAML Module", "HTTPS Edge Route Traffic Policy Module", "HTTPS Edge Route User Agent Filter Module", "HTTPS Edge Route Webhook Verification Module", "HTTPS Edge Route Websocket TCP Converter Module", "HTTPS Edges", "HTTPS Edge Routes", "TCP Edges", "TLS Edges", "Endpoints", "Errors", "Event Destinations", "Event Sources", "Event Subscriptions", "Failover Backends", "HTTP Response Backends", "HTTPS Edge Mutual TLS Module", "HTTPS Edge TLS Termination Module", "ngrok-api", "IP Policies", "IP Policy Rules", "IP Restrictions", "Reserved Addresses", "Reserved Domains", "Secrets", "Service Users", "SSH Certificate Authorities", "SSH Credentials", "SSH Host Certificates", "SSH User Certificates", "Static Backends", "TCP Edge Backend Module", "TCP Edge IP Restriction Module", "TCP Edge Policy Module", "TCP Edge Traffic Policy Module", "TLS Certificates", "TLS Edge Backend Module", "TLS Edge IP Restriction Module", "TLS Edge Mutual TLS Module", "TLS Edge Policy Module", "TLS EdgeLine truncated
|
||||
+9
-6
@@ -3,9 +3,9 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH Certificate Authorities" href="ssh_certificate_authorities.html" /><link rel="prev" title="Reserved Domains" href="reserved_domains.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Service Users" href="service_users.html" /><link rel="prev" title="Reserved Domains" href="reserved_domains.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Secrets - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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 current current-page"><a class="current reference internal" href="#">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -264,7 +265,7 @@
|
||||
<dd><p>Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SecretsClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vault_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</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">description</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#SecretsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</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">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">vault_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">vault_name</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#SecretsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create a new Secret</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
@@ -274,6 +275,7 @@
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Arbitrary user-defined metadata for this Secret</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – description of Secret</p></li>
|
||||
<li><p><strong>vault_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of the referenced vault</p></li>
|
||||
<li><p><strong>vault_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – name of the referenced vault</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -316,13 +318,14 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SecretsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SecretsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#SecretsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all Secrets owned by account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -366,12 +369,12 @@
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="ssh_certificate_authorities.html">
|
||||
<a class="next-page" href="service_users.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">SSH Certificate Authorities</div>
|
||||
<div class="title">Service Users</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@@ -0,0 +1,440 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH Certificate Authorities" href="ssh_certificate_authorities.html" /><link rel="prev" title="Secrets" href="secrets.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Service Users - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="static_backends.html">Static Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bot_users.html">Bot Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_traffic_policy_module.html">HTTPS Edge Route Traffic Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_traffic_policy_module.html">TCP Edge Traffic Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_traffic_policy_module.html">TLS Edge Traffic Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Service Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="service-users">
|
||||
<h1>Service Users<a class="headerlink" href="#service-users" title="Permalink to this heading">#</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<a class="reference internal" href="client.html#ngrok.Client.service_users" title="ngrok.Client.service_users"><code class="xref py py-attr docutils literal notranslate"><span class="pre">service_users</span></code></a> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.services.ServiceUsersClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">ServiceUsersClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ServiceUsersClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ServiceUsersClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.ServiceUsersClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ServiceUsersClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ServiceUsersClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create a new service user</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable name used to identify the service</p></li>
|
||||
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – whether or not the service is active</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-service-users-create">https://ngrok.com/docs/api#api-service-users-create</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser" title="ngrok.datatypes.ServiceUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceUser</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.ServiceUsersClient.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ServiceUsersClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ServiceUsersClient.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Delete a service user by ID</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-service-users-delete">https://ngrok.com/docs/api#api-service-users-delete</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.ServiceUsersClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ServiceUsersClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ServiceUsersClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Get the details of a Bot User by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-service-users-get">https://ngrok.com/docs/api#api-service-users-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser" title="ngrok.datatypes.ServiceUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceUser</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.ServiceUsersClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#ServiceUsersClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ServiceUsersClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all service users in this account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-service-users-list">https://ngrok.com/docs/api#api-service-users-list</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUserList" title="ngrok.datatypes.ServiceUserList"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceUserList</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.ServiceUsersClient.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ServiceUsersClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ServiceUsersClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Update attributes of a service user by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable name used to identify the service</p></li>
|
||||
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – whether or not the service is active</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-service-users-update">https://ngrok.com/docs/api#api-service-users-update</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ServiceUser" title="ngrok.datatypes.ServiceUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceUser</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="ssh_certificate_authorities.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">SSH Certificate Authorities</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="secrets.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Secrets</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Users</a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.ServiceUsersClient"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.ServiceUsersClient.create"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.create()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.ServiceUsersClient.delete"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.ServiceUsersClient.get"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.ServiceUsersClient.list"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.list()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.ServiceUsersClient.update"><code class="docutils literal notranslate"><span class="pre">ServiceUsersClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/scripts/furo.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -3,9 +3,9 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH Credentials" href="ssh_credentials.html" /><link rel="prev" title="Secrets" href="secrets.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH Credentials" href="ssh_credentials.html" /><link rel="prev" title="Service Users" href="service_users.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>SSH Certificate Authorities - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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>
|
||||
@@ -301,7 +302,7 @@ key that can be used to sign other SSH host and user certificates.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SSHCertificateAuthoritiesClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHCertificateAuthoritiesClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCertificateAuthoritiesClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Get detailed information about an SSH Certficate Authority</p>
|
||||
<dd><p>Get detailed information about an SSH Certificate Authority</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
@@ -317,13 +318,14 @@ key that can be used to sign other SSH host and user certificates.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SSHCertificateAuthoritiesClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHCertificateAuthoritiesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCertificateAuthoritiesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#SSHCertificateAuthoritiesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCertificateAuthoritiesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all SSH Certificate Authorities on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -374,14 +376,14 @@ key that can be used to sign other SSH host and user certificates.</p>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="secrets.html">
|
||||
<a class="prev-page" href="service_users.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Secrets</div>
|
||||
<div class="title">Service Users</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH Host Certificates" href="ssh_host_certificates.html" /><link rel="prev" title="SSH Certificate Authorities" href="ssh_certificate_authorities.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>SSH Credentials - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
@@ -317,13 +318,14 @@ via the ngrok SSH tunnel gateway.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SSHCredentialsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHCredentialsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCredentialsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#SSHCredentialsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCredentialsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all ssh credentials on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH User Certificates" href="ssh_user_certificates.html" /><link rel="prev" title="SSH Credentials" href="ssh_credentials.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>SSH Host Certificates - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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 current current-page"><a class="current reference internal" href="#">SSH Host Certificates</a></li>
|
||||
@@ -304,7 +305,7 @@ SSH Certificate Authority that was used to sign the certificate.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SSHHostCertificatesClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHHostCertificatesClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHHostCertificatesClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Get detailed information about an SSH Host Certficate</p>
|
||||
<dd><p>Get detailed information about an SSH Host Certificate</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Certificates" href="tls_certificates.html" /><link rel="prev" title="SSH Host Certificates" href="ssh_host_certificates.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>SSH User Certificates - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -307,7 +308,7 @@ Certificate Authority used to sign the certificate.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SSHUserCertificatesClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHUserCertificatesClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHUserCertificatesClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Get detailed information about an SSH User Certficate</p>
|
||||
<dd><p>Get detailed information about an SSH User Certificate</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Tunnel Group Backends" href="tunnel_group_backends.html" /><link rel="prev" title="HTTP Response Backends" href="http_response_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Static Backends - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TCP Edge IP Restriction Module" href="tcp_edge_ip_restriction_module.html" /><link rel="prev" title="TCP Edges" href="edges_tcp.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TCP Edge Backend Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TCP Edge Traffic Policy Module" href="tcp_edge_traffic_policy_module.html" /><link rel="prev" title="TCP Edge Backend Module" href="tcp_edge_backend_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TCP Edge IP Restriction Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TCP Edge Policy Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edges" href="edges_tls.html" /><link rel="prev" title="TCP Edge IP Restriction Module" href="tcp_edge_ip_restriction_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TCP Edge Traffic Policy Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Tunnels" href="tunnels.html" /><link rel="prev" title="SSH User Certificates" href="ssh_user_certificates.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TLS Certificates - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -319,13 +320,14 @@ automated certificate provisioning.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TLSCertificatesClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TLSCertificatesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TLSCertificatesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#TLSCertificatesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TLSCertificatesClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all TLS certificates on this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edge IP Restriction Module" href="tls_edge_ip_restriction_module.html" /><link rel="prev" title="TLS Edges" href="edges_tls.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TLS Edge Backend Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edge Mutual TLS Module" href="tls_edge_mutual_tls_module.html" /><link rel="prev" title="TLS Edge Backend Module" href="tls_edge_backend_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TLS Edge IP Restriction Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edge TLS Termination Module" href="tls_edge_tls_termination_module.html" /><link rel="prev" title="TLS Edge IP Restriction Module" href="tls_edge_ip_restriction_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TLS Edge Mutual TLS Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TLS Edge Policy Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Edge Traffic Policy Module" href="tls_edge_traffic_policy_module.html" /><link rel="prev" title="TLS Edge Mutual TLS Module" href="tls_edge_mutual_tls_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TLS Edge TLS Termination Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Endpoints" href="endpoints.html" /><link rel="prev" title="TLS Edge TLS Termination Module" href="tls_edge_tls_termination_module.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>TLS Edge Traffic Policy Module - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Weighted Backends" href="weighted_backends.html" /><link rel="prev" title="Static Backends" href="static_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Tunnel Group Backends - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Failover Backends" href="failover_backends.html" /><link rel="prev" title="Application Users" href="application_users.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Tunnel Sessions - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -283,13 +284,14 @@ session can include one or more Tunnels.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.TunnelSessionsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#TunnelSessionsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TunnelSessionsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#TunnelSessionsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.TunnelSessionsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all online tunnel sessions running on this account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+2
-1
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Vaults" href="vaults.html" /><link rel="prev" title="TLS Certificates" href="tls_certificates.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Tunnels - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
+4
-2
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Tunnels" href="tunnels.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Vaults - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
@@ -335,13 +336,14 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.VaultsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#VaultsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.VaultsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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#VaultsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.VaultsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all Vaults owned by account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Bot Users" href="bot_users.html" /><link rel="prev" title="Tunnel Group Backends" href="tunnel_group_backends.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<!-- Generated with Sphinx 6.2.0 and Furo 2022.12.07 -->
|
||||
<title>Weighted Backends - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
@@ -213,6 +213,7 @@
|
||||
<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="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="service_users.html">Service Users</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>
|
||||
|
||||
@@ -129,6 +129,10 @@ class Client(object):
|
||||
"""Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""
|
||||
return SecretsClient(self)
|
||||
|
||||
@property
|
||||
def service_users(self) -> ServiceUsersClient:
|
||||
return ServiceUsersClient(self)
|
||||
|
||||
@property
|
||||
def ssh_certificate_authorities(self) -> SSHCertificateAuthoritiesClient:
|
||||
"""An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
||||
|
||||
+103
-2
@@ -3686,7 +3686,7 @@ class Endpoint(object):
|
||||
description: str = None,
|
||||
metadata: str = None,
|
||||
bindings: Sequence[str] = None,
|
||||
pooling_enabled: bool = False,
|
||||
pooling_enabled: bool = None,
|
||||
):
|
||||
self._client.endpoints.update(
|
||||
id=self.id,
|
||||
@@ -3727,7 +3727,7 @@ class Endpoint(object):
|
||||
|
||||
@property
|
||||
def public_url(self) -> str:
|
||||
"""URL of the hostport served by this endpoint"""
|
||||
"""deprecated [replaced by URL]: URL of the hostport served by this endpoint"""
|
||||
return self._props["public_url"]
|
||||
|
||||
@property
|
||||
@@ -5189,6 +5189,11 @@ class Secret(object):
|
||||
"""Reference to the vault the secret is stored in"""
|
||||
return self._props["vault"]
|
||||
|
||||
@property
|
||||
def vault_name(self) -> str:
|
||||
"""Name of the vault the secret is stored in"""
|
||||
return self._props["vault_name"]
|
||||
|
||||
|
||||
class SecretList(object):
|
||||
def __init__(self, client, props):
|
||||
@@ -5227,6 +5232,102 @@ class SecretList(object):
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class ServiceUser(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<ServiceUser {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<ServiceUser {}>".format(repr(self._props))
|
||||
|
||||
def delete(
|
||||
self,
|
||||
):
|
||||
self._client.service_users.delete(
|
||||
id=self.id,
|
||||
)
|
||||
|
||||
def update(
|
||||
self,
|
||||
name: str = None,
|
||||
active: bool = None,
|
||||
):
|
||||
self._client.service_users.update(
|
||||
id=self.id,
|
||||
name=name,
|
||||
active=active,
|
||||
)
|
||||
|
||||
@property
|
||||
def id(self) -> str:
|
||||
"""unique API key resource identifier"""
|
||||
return self._props["id"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI to the API resource of this service user"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def name(self) -> str:
|
||||
"""human-readable name used to identify the service"""
|
||||
return self._props["name"]
|
||||
|
||||
@property
|
||||
def active(self) -> bool:
|
||||
"""whether or not the service is active"""
|
||||
return self._props["active"]
|
||||
|
||||
@property
|
||||
def created_at(self) -> datetime:
|
||||
"""timestamp when the api key was created, RFC 3339 format"""
|
||||
return self._props["created_at"]
|
||||
|
||||
|
||||
class ServiceUserList(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["service_users"] = (
|
||||
[ServiceUser(client, x) for x in props["service_users"]]
|
||||
if props.get("service_users") is not None
|
||||
else []
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<ServiceUserList {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<ServiceUserList {}>".format(repr(self._props))
|
||||
|
||||
def __iter__(self):
|
||||
return PagedIterator(self._client, self, "service_users")
|
||||
|
||||
@property
|
||||
def service_users(self) -> Sequence[ServiceUser]:
|
||||
"""the list of all service users on this account"""
|
||||
return self._props["service_users"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of the service users list API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def next_page_uri(self) -> str:
|
||||
"""URI of the next page, or null if there is no next page"""
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class SSHCertificateAuthority(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
|
||||
+172
-7
@@ -126,11 +126,13 @@ class AgentIngressesClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> AgentIngressList:
|
||||
"""List all Agent Ingresses owned by this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-agent-ingresses-list
|
||||
"""
|
||||
@@ -138,6 +140,7 @@ class AgentIngressesClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return AgentIngressList(self._client, result)
|
||||
@@ -243,11 +246,13 @@ class APIKeysClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> APIKeyList:
|
||||
"""List all API keys owned by this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-api-keys-list
|
||||
"""
|
||||
@@ -255,6 +260,7 @@ class APIKeysClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return APIKeyList(self._client, result)
|
||||
@@ -417,11 +423,13 @@ class TunnelSessionsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> TunnelSessionList:
|
||||
"""List all online tunnel sessions running on this account.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-tunnel-sessions-list
|
||||
"""
|
||||
@@ -429,6 +437,7 @@ class TunnelSessionsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return TunnelSessionList(self._client, result)
|
||||
@@ -1251,7 +1260,7 @@ class CertificateAuthoritiesClient(object):
|
||||
self,
|
||||
id: str,
|
||||
) -> CertificateAuthority:
|
||||
"""Get detailed information about a certficate authority
|
||||
"""Get detailed information about a certificate authority
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
@@ -1269,11 +1278,13 @@ class CertificateAuthoritiesClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> CertificateAuthorityList:
|
||||
"""List all Certificate Authority on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-certificate-authorities-list
|
||||
"""
|
||||
@@ -1281,6 +1292,7 @@ class CertificateAuthoritiesClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return CertificateAuthorityList(self._client, result)
|
||||
@@ -1385,11 +1397,13 @@ class CredentialsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> CredentialList:
|
||||
"""List all tunnel authtoken credentials on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-credentials-list
|
||||
"""
|
||||
@@ -1397,6 +1411,7 @@ class CredentialsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return CredentialList(self._client, result)
|
||||
@@ -3525,7 +3540,7 @@ class EndpointsClient(object):
|
||||
description: str = None,
|
||||
metadata: str = None,
|
||||
bindings: Sequence[str] = None,
|
||||
pooling_enabled: bool = False,
|
||||
pooling_enabled: bool = None,
|
||||
) -> Endpoint:
|
||||
"""Create an endpoint, currently available only for cloud endpoints
|
||||
|
||||
@@ -3558,6 +3573,7 @@ class EndpointsClient(object):
|
||||
limit: str = None,
|
||||
id: Sequence[str] = [],
|
||||
url: Sequence[str] = [],
|
||||
filter: str = None,
|
||||
) -> EndpointList:
|
||||
"""List all active endpoints on the account
|
||||
|
||||
@@ -3565,6 +3581,7 @@ class EndpointsClient(object):
|
||||
:param limit:
|
||||
:param id:
|
||||
:param url:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoints-list
|
||||
"""
|
||||
@@ -3574,6 +3591,7 @@ class EndpointsClient(object):
|
||||
limit=limit,
|
||||
id=id,
|
||||
url=url,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return EndpointList(self._client, result)
|
||||
@@ -3604,7 +3622,7 @@ class EndpointsClient(object):
|
||||
description: str = None,
|
||||
metadata: str = None,
|
||||
bindings: Sequence[str] = None,
|
||||
pooling_enabled: bool = False,
|
||||
pooling_enabled: bool = None,
|
||||
) -> Endpoint:
|
||||
"""Update an Endpoint by ID, currently available only for cloud endpoints
|
||||
|
||||
@@ -3720,11 +3738,13 @@ class EventDestinationsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> EventDestinationList:
|
||||
"""List all Event Destinations on this account.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-event-destinations-list
|
||||
"""
|
||||
@@ -3732,6 +3752,7 @@ class EventDestinationsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return EventDestinationList(self._client, result)
|
||||
@@ -3837,11 +3858,13 @@ class EventSubscriptionsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> EventSubscriptionList:
|
||||
"""List this Account's Event Subscriptions.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-event-subscriptions-list
|
||||
"""
|
||||
@@ -3849,6 +3872,7 @@ class EventSubscriptionsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return EventSubscriptionList(self._client, result)
|
||||
@@ -4060,11 +4084,13 @@ class IPPoliciesClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> IPPolicyList:
|
||||
"""List all IP policies on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-ip-policies-list
|
||||
"""
|
||||
@@ -4072,6 +4098,7 @@ class IPPoliciesClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return IPPolicyList(self._client, result)
|
||||
@@ -4177,11 +4204,13 @@ class IPPolicyRulesClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> IPPolicyRuleList:
|
||||
"""List all IP policy rules on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-ip-policy-rules-list
|
||||
"""
|
||||
@@ -4189,6 +4218,7 @@ class IPPolicyRulesClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return IPPolicyRuleList(self._client, result)
|
||||
@@ -4301,11 +4331,13 @@ class IPRestrictionsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> IPRestrictionList:
|
||||
"""List all IP restrictions on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-ip-restrictions-list
|
||||
"""
|
||||
@@ -4313,6 +4345,7 @@ class IPRestrictionsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return IPRestrictionList(self._client, result)
|
||||
@@ -4419,11 +4452,13 @@ class ReservedAddrsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> ReservedAddrList:
|
||||
"""List all reserved addresses on this account.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-reserved-addrs-list
|
||||
"""
|
||||
@@ -4431,6 +4466,7 @@ class ReservedAddrsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return ReservedAddrList(self._client, result)
|
||||
@@ -4541,11 +4577,13 @@ class ReservedDomainsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> ReservedDomainList:
|
||||
"""List all reserved domains on this account.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-reserved-domains-list
|
||||
"""
|
||||
@@ -4553,6 +4591,7 @@ class ReservedDomainsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return ReservedDomainList(self._client, result)
|
||||
@@ -4631,11 +4670,12 @@ class SecretsClient(object):
|
||||
|
||||
def create(
|
||||
self,
|
||||
vault_id: str,
|
||||
name: str = "",
|
||||
value: str = "",
|
||||
metadata: str = "",
|
||||
description: str = "",
|
||||
vault_id: str = "",
|
||||
vault_name: str = "",
|
||||
) -> Secret:
|
||||
"""Create a new Secret
|
||||
|
||||
@@ -4644,6 +4684,7 @@ class SecretsClient(object):
|
||||
:param metadata: Arbitrary user-defined metadata for this Secret
|
||||
:param description: description of Secret
|
||||
:param vault_id: unique identifier of the referenced vault
|
||||
:param vault_name: name of the referenced vault
|
||||
|
||||
https://ngrok.com/docs/api#api-secrets-create
|
||||
"""
|
||||
@@ -4654,6 +4695,7 @@ class SecretsClient(object):
|
||||
metadata=metadata,
|
||||
description=description,
|
||||
vault_id=vault_id,
|
||||
vault_name=vault_name,
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return Secret(self._client, result)
|
||||
@@ -4728,11 +4770,13 @@ class SecretsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> SecretList:
|
||||
"""List all Secrets owned by account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-secrets-list
|
||||
"""
|
||||
@@ -4740,11 +4784,120 @@ class SecretsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return SecretList(self._client, result)
|
||||
|
||||
|
||||
class ServiceUsersClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def create(
|
||||
self,
|
||||
name: str = "",
|
||||
active: bool = None,
|
||||
) -> ServiceUser:
|
||||
"""Create a new service user
|
||||
|
||||
:param name: human-readable name used to identify the service
|
||||
:param active: whether or not the service is active
|
||||
|
||||
https://ngrok.com/docs/api#api-service-users-create
|
||||
"""
|
||||
path = "/service_users"
|
||||
body_arg = dict(
|
||||
name=name,
|
||||
active=active,
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return ServiceUser(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete a service user by ID
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-service-users-delete
|
||||
"""
|
||||
path = "/service_users/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> ServiceUser:
|
||||
"""Get the details of a Bot User by ID.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-service-users-get
|
||||
"""
|
||||
path = "/service_users/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return ServiceUser(self._client, result)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> ServiceUserList:
|
||||
"""List all service users in this account.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-service-users-list
|
||||
"""
|
||||
path = "/service_users"
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return ServiceUserList(self._client, result)
|
||||
|
||||
def update(
|
||||
self,
|
||||
id: str,
|
||||
name: str = None,
|
||||
active: bool = None,
|
||||
) -> ServiceUser:
|
||||
"""Update attributes of a service user by ID.
|
||||
|
||||
:param id:
|
||||
:param name: human-readable name used to identify the service
|
||||
:param active: whether or not the service is active
|
||||
|
||||
https://ngrok.com/docs/api#api-service-users-update
|
||||
"""
|
||||
path = "/service_users/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = dict(
|
||||
name=name,
|
||||
active=active,
|
||||
)
|
||||
result = self._client.http_client.patch(path, body_arg)
|
||||
return ServiceUser(self._client, result)
|
||||
|
||||
|
||||
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."""
|
||||
@@ -4802,7 +4955,7 @@ class SSHCertificateAuthoritiesClient(object):
|
||||
self,
|
||||
id: str,
|
||||
) -> SSHCertificateAuthority:
|
||||
"""Get detailed information about an SSH Certficate Authority
|
||||
"""Get detailed information about an SSH Certificate Authority
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
@@ -4820,11 +4973,13 @@ class SSHCertificateAuthoritiesClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> SSHCertificateAuthorityList:
|
||||
"""List all SSH Certificate Authorities on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-ssh-certificate-authorities-list
|
||||
"""
|
||||
@@ -4832,6 +4987,7 @@ class SSHCertificateAuthoritiesClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return SSHCertificateAuthorityList(self._client, result)
|
||||
@@ -4937,11 +5093,13 @@ class SSHCredentialsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> SSHCredentialList:
|
||||
"""List all ssh credentials on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-ssh-credentials-list
|
||||
"""
|
||||
@@ -4949,6 +5107,7 @@ class SSHCredentialsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return SSHCredentialList(self._client, result)
|
||||
@@ -5046,7 +5205,7 @@ class SSHHostCertificatesClient(object):
|
||||
self,
|
||||
id: str,
|
||||
) -> SSHHostCertificate:
|
||||
"""Get detailed information about an SSH Host Certficate
|
||||
"""Get detailed information about an SSH Host Certificate
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
@@ -5176,7 +5335,7 @@ class SSHUserCertificatesClient(object):
|
||||
self,
|
||||
id: str,
|
||||
) -> SSHUserCertificate:
|
||||
"""Get detailed information about an SSH User Certficate
|
||||
"""Get detailed information about an SSH User Certificate
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
@@ -5311,11 +5470,13 @@ class TLSCertificatesClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> TLSCertificateList:
|
||||
"""List all TLS certificates on this account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-tls-certificates-list
|
||||
"""
|
||||
@@ -5323,6 +5484,7 @@ class TLSCertificatesClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return TLSCertificateList(self._client, result)
|
||||
@@ -5520,11 +5682,13 @@ class VaultsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
filter: str = None,
|
||||
) -> VaultList:
|
||||
"""List all Vaults owned by account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param filter:
|
||||
|
||||
https://ngrok.com/docs/api#api-vaults-list
|
||||
"""
|
||||
@@ -5532,6 +5696,7 @@ class VaultsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
filter=filter,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return VaultList(self._client, result)
|
||||
Reference in new issue
Block a user