ngrok/ngrok-api-python
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-python.git synced 2026-05-17 16:50:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8 from ngrok/staging

Browse Source 
cut new release
This commit is contained in:
Alan Shreve
2021-05-21 08:03:58 -07:00
committed by GitHub
parent 436d30f0cd 9c8e482eaa
commit 562bf79d1d
65 changed files with 3875 additions and 2521 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
+1 -1
View File
@@ -2,4 +2,4 @@ doc/build
.pyc
.swp
__pycache__
.egg-info
/ngrok_api.egg-info
README.md
+1 -1
View File
@@ -1,4 +1,4 @@
# ngrok API client library
# ngrok API client library for Python
This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
easier to consume in Python.
doc/source/datatypes.rst
+8
View File
@@ -0,0 +1,8 @@
Datatypes
=====================================
This module contains all datatypes returned by the ngrok API.
.. automodule:: ngrok.datatypes
:members:
:undoc-members:
doc/source/errors.rst
+1 -1
View File
@@ -36,7 +36,7 @@ documentation for the `list of all ngrok error codes <https://ngrok.com/docs/err
try:
c.ip_policies.create(action="something invalid")
except ngrok.Error as e:
if e.error_code == 1410:
if e.error_code == "ERR_NGROK_1410":
# handle a specific condition
else:
raise
doc/source/index.rst
+1 -1
View File
@@ -110,7 +110,7 @@ API Reference
:caption: API
client
objects
datatypes
errors
.. toctree::
doc/source/objects.rst
-8
View File
@@ -1,8 +0,0 @@
Objects
=====================================
This module contains all object types returned by the ngrok API.
.. automodule:: ngrok.objects
:members:
:undoc-members:
docs/_modules/index.html
+2 -2
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="../datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -163,8 +163,8 @@
</label>
<h1>All modules for which code is available</h1>
<ul><li><a href="ngrok/client.html">ngrok.client</a></li>
<li><a href="ngrok/datatypes.html">ngrok.datatypes</a></li>
<li><a href="ngrok/error.html">ngrok.error</a></li>
<li><a href="ngrok/objects.html">ngrok.objects</a></li>
<li><a href="ngrok/services.html">ngrok.services</a></li>
</ul>
</article>
docs/_modules/ngrok/client.html
+3 -4
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -169,9 +169,8 @@
<div class="viewcode-block" id="Client"><a class="viewcode-back" href="../../client.html#ngrok.Client">[docs]</a><span class="k">class</span> <span class="nc">Client</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">api_key</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">base_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"https://api.ngrok.com"</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_key</span> <span class="o">=</span> <span class="n">api_key</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">"NGROK_API_KEY"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_client</span> <span class="o">=</span> <span class="n">APIClient</span><span class="p">(</span><span class="n">api_key</span><span class="p">,</span> <span class="n">base_url</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">api_key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">base_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"https://api.ngrok.com"</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">http_client</span> <span class="o">=</span> <span class="n">HTTPClient</span><span class="p">(</span><span class="n">api_key</span><span class="p">,</span> <span class="n">base_url</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">abuse_reports</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AbuseReportsClient</span><span class="p">:</span>
docs/_modules/ngrok/objects.html → docs/_modules/ngrok/datatypes.html
+487 -255
View File
File diff suppressed because it is too large Load Diff
docs/_modules/ngrok/error.html
+10 -2
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -187,7 +187,15 @@
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">error_code</span> <span class="o">=</span> <span class="n">error_code</span>
<span class="bp">self</span><span class="o">.</span><span class="n">http_status_code</span> <span class="o">=</span> <span class="n">http_status_code</span>
<span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="n">details</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="n">details</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">operation_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> OperationID returns the unique trace ID assigned by ngrok to this API</span>
<span class="sd"> request.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"operation_id"</span><span class="p">)</span></div>
<div class="viewcode-block" id="NotFoundError"><a class="viewcode-back" href="../../errors.html#ngrok.NotFoundError">[docs]</a><span class="k">class</span> <span class="nc">NotFoundError</span><span class="p">(</span><span class="n">Error</span><span class="p">):</span>
docs/_modules/ngrok/services.html
+405 -137
View File
File diff suppressed because it is too large Load Diff
docs/_sources/datatypes.rst.txt
+8
View File
@@ -0,0 +1,8 @@
Datatypes
=====================================
This module contains all datatypes returned by the ngrok API.
.. automodule:: ngrok.datatypes
:members:
:undoc-members:
docs/_sources/errors.rst.txt
+1 -1
View File
@@ -36,7 +36,7 @@ documentation for the `list of all ngrok error codes <https://ngrok.com/docs/err
try:
c.ip_policies.create(action="something invalid")
except ngrok.Error as e:
if e.error_code == 1410:
if e.error_code == "ERR_NGROK_1410":
# handle a specific condition
else:
raise
docs/_sources/index.rst.txt
+1 -1
View File
@@ -110,7 +110,7 @@ API Reference
:caption: API
client
objects
datatypes
errors
.. toctree::
docs/_sources/objects.rst.txt
-8
View File
@@ -1,8 +0,0 @@
Objects
=====================================
This module contains all object types returned by the ngrok API.
.. automodule:: ngrok.objects
:members:
:undoc-members:
docs/abuse_reports.html
+11 -5
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -179,8 +179,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.AbuseReport" title="ngrok.objects.AbuseReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbuseReport</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-abuse-reports-create">https://ngrok.com/docs/api#api-abuse-reports-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.AbuseReport" title="ngrok.datatypes.AbuseReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbuseReport</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -192,8 +195,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.AbuseReport" title="ngrok.objects.AbuseReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbuseReport</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-abuse-reports-get">https://ngrok.com/docs/api#api-abuse-reports-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.AbuseReport" title="ngrok.datatypes.AbuseReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbuseReport</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/api_keys.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -179,8 +179,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined data of this API key. optional, max 4096 bytes</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.APIKey" title="ngrok.objects.APIKey"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKey</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-api-keys-create">https://ngrok.com/docs/api#api-api-keys-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.APIKey" title="ngrok.datatypes.APIKey"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKey</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -193,6 +196,7 @@
<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-api-keys-delete">https://ngrok.com/docs/api#api-api-keys-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.APIKeysClient.get">
@@ -202,8 +206,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.APIKey" title="ngrok.objects.APIKey"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKey</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-api-keys-get">https://ngrok.com/docs/api#api-api-keys-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.APIKey" title="ngrok.datatypes.APIKey"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKey</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -218,8 +225,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.APIKeyList" title="ngrok.objects.APIKeyList"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKeyList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-api-keys-list">https://ngrok.com/docs/api#api-api-keys-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.APIKeyList" title="ngrok.datatypes.APIKeyList"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKeyList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -235,8 +245,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined data of this API key. optional, max 4096 bytes</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.APIKey" title="ngrok.objects.APIKey"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKey</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-api-keys-update">https://ngrok.com/docs/api#api-api-keys-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.APIKey" title="ngrok.datatypes.APIKey"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKey</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/certificate_authorities.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -180,8 +180,11 @@
<li><p><strong>ca_pem</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – raw PEM of the Certificate Authority</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.CertificateAuthority" title="ngrok.objects.CertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthority</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-certificate-authorities-create">https://ngrok.com/docs/api#api-certificate-authorities-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.CertificateAuthority" title="ngrok.datatypes.CertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthority</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -194,6 +197,7 @@
<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-certificate-authorities-delete">https://ngrok.com/docs/api#api-certificate-authorities-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.CertificateAuthoritiesClient.get">
@@ -203,8 +207,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.CertificateAuthority" title="ngrok.objects.CertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthority</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-certificate-authorities-get">https://ngrok.com/docs/api#api-certificate-authorities-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.CertificateAuthority" title="ngrok.datatypes.CertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthority</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -219,8 +226,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.CertificateAuthorityList" title="ngrok.objects.CertificateAuthorityList"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthorityList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-certificate-authorities-list">https://ngrok.com/docs/api#api-certificate-authorities-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.CertificateAuthorityList" title="ngrok.datatypes.CertificateAuthorityList"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthorityList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -236,8 +246,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.CertificateAuthority" title="ngrok.objects.CertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthority</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-certificate-authorities-update">https://ngrok.com/docs/api#api-certificate-authorities-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.CertificateAuthority" title="ngrok.datatypes.CertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthority</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/client.html
+5 -5
View File
@@ -2,7 +2,7 @@
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Objects" href="objects.html" /><link rel="prev" title="ngrok-api" href="index.html" />
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Datatypes" href="datatypes.html" /><link rel="prev" title="ngrok-api" href="index.html" />
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
<title>Client - ngrok-api documentation</title>
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul class="current">
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -182,7 +182,7 @@ Client object:</p>
</div>
<span class="target" id="module-ngrok"></span><dl class="py class">
<dt id="ngrok.Client">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.</span></code><code class="sig-name descname"><span class="pre">Client</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_key</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">base_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'https://api.ngrok.com'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/client.html#Client"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.Client" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.</span></code><code class="sig-name descname"><span class="pre">Client</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'https://api.ngrok.com'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/client.html#Client"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.Client" title="Permalink to this definition"></a></dt>
<dd><dl class="py method">
<dt id="ngrok.Client.abuse_reports">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">abuse_reports</span></code><a class="headerlink" href="#ngrok.Client.abuse_reports" title="Permalink to this definition"></a></dt>
@@ -376,12 +376,12 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
<footer>
<div class="related-pages">
<a class="next-page" href="objects.html">
<a class="next-page" href="datatypes.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Objects</div>
<div class="title">Datatypes</div>
</div>
<svg><use href="#svg-arrow-right"></use></svg>
</a>
docs/credentials.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -180,8 +180,11 @@
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.Credential" title="ngrok.objects.Credential"><code class="xref py py-class docutils literal notranslate"><span class="pre">Credential</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-credentials-create">https://ngrok.com/docs/api#api-credentials-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Credential" title="ngrok.datatypes.Credential"><code class="xref py py-class docutils literal notranslate"><span class="pre">Credential</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -194,6 +197,7 @@
<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-credentials-delete">https://ngrok.com/docs/api#api-credentials-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.CredentialsClient.get">
@@ -203,8 +207,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.Credential" title="ngrok.objects.Credential"><code class="xref py py-class docutils literal notranslate"><span class="pre">Credential</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-credentials-get">https://ngrok.com/docs/api#api-credentials-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Credential" title="ngrok.datatypes.Credential"><code class="xref py py-class docutils literal notranslate"><span class="pre">Credential</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -219,8 +226,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.CredentialList" title="ngrok.objects.CredentialList"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-credentials-list">https://ngrok.com/docs/api#api-credentials-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.CredentialList" title="ngrok.datatypes.CredentialList"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -237,8 +247,11 @@
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.Credential" title="ngrok.objects.Credential"><code class="xref py py-class docutils literal notranslate"><span class="pre">Credential</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-credentials-update">https://ngrok.com/docs/api#api-credentials-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Credential" title="ngrok.datatypes.Credential"><code class="xref py py-class docutils literal notranslate"><span class="pre">Credential</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/objects.html → docs/datatypes.html
+1027 -1027
View File
File diff suppressed because it is too large Load Diff
docs/endpoint_circuit_breaker_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-circuit-breaker-module-delete">https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointCircuitBreakerModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointCircuitBreaker" title="ngrok.objects.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get">https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointCircuitBreaker" title="ngrok.objects.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointCircuitBreaker" title="ngrok.objects.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace">https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_compression_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-compression-module-delete">https://ngrok.com/docs/api#api-endpoint-compression-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointCompressionModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointCompression" title="ngrok.objects.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-compression-module-get">https://ngrok.com/docs/api#api-endpoint-compression-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointCompression" title="ngrok.objects.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointCompression" title="ngrok.objects.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-compression-module-replace">https://ngrok.com/docs/api#api-endpoint-compression-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_configurations.html
+46 -33
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -180,22 +180,25 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – they type of traffic this endpoint configuration can be applied to. one of: <code class="docutils literal notranslate"><span class="pre">http</span></code>, <code class="docutils literal notranslate"><span class="pre">https</span></code>, <code class="docutils literal notranslate"><span class="pre">tcp</span></code></p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p></li>
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p></li>
<li><p><strong>circuit_breaker</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointCircuitBreaker" title="ngrok.objects.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>]) – circuit breaker module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>compression</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointCompression" title="ngrok.objects.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>]) – compression module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>request_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointRequestHeaders" title="ngrok.objects.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>]) – request headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>response_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointResponseHeaders" title="ngrok.objects.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>]) – response headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>ip_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointIPPolicyMutate" title="ngrok.objects.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>]) – ip policy module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>mutual_tls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointMutualTLSMutate" title="ngrok.objects.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>]) – mutual TLS module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>tls_termination</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointTLSTermination" title="ngrok.objects.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>]) – TLS termination module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>webhook_validation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointWebhookValidation" title="ngrok.objects.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>]) – webhook validation module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>oauth</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointOAuth" title="ngrok.objects.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>]) – oauth module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>logging</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointLoggingMutate" title="ngrok.objects.EndpointLoggingMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLoggingMutate</span></code></a>]) – logging module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>saml</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointSAMLMutate" title="ngrok.objects.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>]) – saml module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>oidc</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointOIDC" title="ngrok.objects.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>]) – oidc module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>circuit_breaker</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>]) – circuit breaker module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>compression</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>]) – compression module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>request_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>]) – request headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>response_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>]) – response headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>ip_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>]) – ip policy module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>mutual_tls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>]) – mutual TLS module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>tls_termination</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>]) – TLS termination module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>webhook_validation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>]) – webhook validation module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>oauth</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>]) – oauth module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>logging</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointLoggingMutate" title="ngrok.datatypes.EndpointLoggingMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLoggingMutate</span></code></a>]) – logging module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>saml</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate" title="ngrok.datatypes.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>]) – saml module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>oidc</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>]) – oidc module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointConfiguration" title="ngrok.objects.EndpointConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfiguration</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-configurations-create">https://ngrok.com/docs/api#api-endpoint-configurations-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointConfiguration" title="ngrok.datatypes.EndpointConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfiguration</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -208,6 +211,7 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
<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-endpoint-configurations-delete">https://ngrok.com/docs/api#api-endpoint-configurations-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointConfigurationsClient.get">
@@ -217,8 +221,11 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointConfiguration" title="ngrok.objects.EndpointConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfiguration</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-configurations-get">https://ngrok.com/docs/api#api-endpoint-configurations-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointConfiguration" title="ngrok.datatypes.EndpointConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfiguration</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -233,8 +240,11 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointConfigurationList" title="ngrok.objects.EndpointConfigurationList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfigurationList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-configurations-list">https://ngrok.com/docs/api#api-endpoint-configurations-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointConfigurationList" title="ngrok.datatypes.EndpointConfigurationList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfigurationList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -248,22 +258,25 @@ a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of this endpoint configuration</p></li>
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p></li>
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p></li>
<li><p><strong>circuit_breaker</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointCircuitBreaker" title="ngrok.objects.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>]) – circuit breaker module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>compression</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointCompression" title="ngrok.objects.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>]) – compression module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>request_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointRequestHeaders" title="ngrok.objects.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>]) – request headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>response_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointResponseHeaders" title="ngrok.objects.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>]) – response headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>ip_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointIPPolicyMutate" title="ngrok.objects.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>]) – ip policy module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>mutual_tls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointMutualTLSMutate" title="ngrok.objects.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>]) – mutual TLS module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>tls_termination</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointTLSTermination" title="ngrok.objects.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>]) – TLS termination module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>webhook_validation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointWebhookValidation" title="ngrok.objects.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>]) – webhook validation module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>oauth</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointOAuth" title="ngrok.objects.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>]) – oauth module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>logging</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointLoggingMutate" title="ngrok.objects.EndpointLoggingMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLoggingMutate</span></code></a>]) – logging module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>saml</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointSAMLMutate" title="ngrok.objects.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>]) – saml module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>oidc</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointOIDC" title="ngrok.objects.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>]) – oidc module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>circuit_breaker</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a>]) – circuit breaker module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>compression</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a>]) – compression module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>request_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>]) – request headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>response_headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>]) – response headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>ip_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>]) – ip policy module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>mutual_tls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>]) – mutual TLS module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>tls_termination</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>]) – TLS termination module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>webhook_validation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>]) – webhook validation module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>oauth</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>]) – oauth module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>logging</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointLoggingMutate" title="ngrok.datatypes.EndpointLoggingMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLoggingMutate</span></code></a>]) – logging module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>saml</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate" title="ngrok.datatypes.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>]) – saml module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
<li><p><strong>oidc</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>]) – oidc module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointConfiguration" title="ngrok.objects.EndpointConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfiguration</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-configurations-update">https://ngrok.com/docs/api#api-endpoint-configurations-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointConfiguration" title="ngrok.datatypes.EndpointConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfiguration</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_ip_policy_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-ip-policy-module-delete">https://ngrok.com/docs/api#api-endpoint-ip-policy-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointIPPolicyModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointIPPolicy" title="ngrok.objects.EndpointIPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicy</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-ip-policy-module-get">https://ngrok.com/docs/api#api-endpoint-ip-policy-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicy" title="ngrok.datatypes.EndpointIPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicy</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointIPPolicyMutate" title="ngrok.objects.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicyMutate" title="ngrok.datatypes.EndpointIPPolicyMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicyMutate</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointIPPolicy" title="ngrok.objects.EndpointIPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicy</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-ip-policy-module-replace">https://ngrok.com/docs/api#api-endpoint-ip-policy-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointIPPolicy" title="ngrok.datatypes.EndpointIPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicy</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_logging_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-logging-module-delete">https://ngrok.com/docs/api#api-endpoint-logging-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointLoggingModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointLogging" title="ngrok.objects.EndpointLogging"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLogging</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-logging-module-get">https://ngrok.com/docs/api#api-endpoint-logging-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointLogging" title="ngrok.datatypes.EndpointLogging"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLogging</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointLoggingMutate" title="ngrok.objects.EndpointLoggingMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLoggingMutate</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointLoggingMutate" title="ngrok.datatypes.EndpointLoggingMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLoggingMutate</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointLogging" title="ngrok.objects.EndpointLogging"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLogging</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-logging-module-replace">https://ngrok.com/docs/api#api-endpoint-logging-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointLogging" title="ngrok.datatypes.EndpointLogging"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLogging</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_mutual_tls_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-mutual-tls-module-delete">https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointMutualTLSModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointMutualTLS" title="ngrok.objects.EndpointMutualTLS"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLS</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-get">https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLS" title="ngrok.datatypes.EndpointMutualTLS"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLS</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointMutualTLSMutate" title="ngrok.objects.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate" title="ngrok.datatypes.EndpointMutualTLSMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLSMutate</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointMutualTLS" title="ngrok.objects.EndpointMutualTLS"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLS</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-replace">https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointMutualTLS" title="ngrok.datatypes.EndpointMutualTLS"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLS</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_o_auth_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-o-auth-module-delete">https://ngrok.com/docs/api#api-endpoint-o-auth-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointOAuthModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointOAuth" title="ngrok.objects.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-o-auth-module-get">https://ngrok.com/docs/api#api-endpoint-o-auth-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointOAuth" title="ngrok.objects.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointOAuth" title="ngrok.objects.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-o-auth-module-replace">https://ngrok.com/docs/api#api-endpoint-o-auth-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_oidc_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-oidc-module-delete">https://ngrok.com/docs/api#api-endpoint-oidc-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointOIDCModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointOIDC" title="ngrok.objects.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-oidc-module-get">https://ngrok.com/docs/api#api-endpoint-oidc-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointOIDC" title="ngrok.objects.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointOIDC" title="ngrok.objects.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-oidc-module-replace">https://ngrok.com/docs/api#api-endpoint-oidc-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_request_headers_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-request-headers-module-delete">https://ngrok.com/docs/api#api-endpoint-request-headers-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointRequestHeadersModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointRequestHeaders" title="ngrok.objects.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-request-headers-module-get">https://ngrok.com/docs/api#api-endpoint-request-headers-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointRequestHeaders" title="ngrok.objects.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointRequestHeaders" title="ngrok.objects.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-request-headers-module-replace">https://ngrok.com/docs/api#api-endpoint-request-headers-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_response_headers_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-response-headers-module-delete">https://ngrok.com/docs/api#api-endpoint-response-headers-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointResponseHeadersModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointResponseHeaders" title="ngrok.objects.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-response-headers-module-get">https://ngrok.com/docs/api#api-endpoint-response-headers-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointResponseHeaders" title="ngrok.objects.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointResponseHeaders" title="ngrok.objects.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-response-headers-module-replace">https://ngrok.com/docs/api#api-endpoint-response-headers-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_saml_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-saml-module-delete">https://ngrok.com/docs/api#api-endpoint-saml-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointSAMLModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointSAML" title="ngrok.objects.EndpointSAML"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAML</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-saml-module-get">https://ngrok.com/docs/api#api-endpoint-saml-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAML" title="ngrok.datatypes.EndpointSAML"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAML</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointSAMLMutate" title="ngrok.objects.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate" title="ngrok.datatypes.EndpointSAMLMutate"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAMLMutate</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointSAML" title="ngrok.objects.EndpointSAML"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAML</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-saml-module-replace">https://ngrok.com/docs/api#api-endpoint-saml-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointSAML" title="ngrok.datatypes.EndpointSAML"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAML</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_tls_termination_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-tls-termination-module-delete">https://ngrok.com/docs/api#api-endpoint-tls-termination-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointTLSTerminationModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointTLSTermination" title="ngrok.objects.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-tls-termination-module-get">https://ngrok.com/docs/api#api-endpoint-tls-termination-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointTLSTermination" title="ngrok.objects.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointTLSTermination" title="ngrok.objects.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-tls-termination-module-replace">https://ngrok.com/docs/api#api-endpoint-tls-termination-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/endpoint_webhook_validation_module.html
+13 -6
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,6 +176,7 @@
<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-endpoint-webhook-validation-module-delete">https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EndpointWebhookValidationModuleClient.get">
@@ -184,8 +185,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointWebhookValidation" title="ngrok.objects.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-get">https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,11 +200,14 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EndpointWebhookValidation" title="ngrok.objects.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>]) – </p></li>
<li><p><strong>module</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EndpointWebhookValidation" title="ngrok.objects.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-replace">https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-replace</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/errors.html
+11 -5
View File
@@ -2,7 +2,7 @@
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Abuse Reports" href="abuse_reports.html" /><link rel="prev" title="Objects" href="objects.html" />
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Abuse Reports" href="abuse_reports.html" /><link rel="prev" title="Datatypes" href="datatypes.html" />
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
<title>Errors - ngrok-api documentation</title>
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -186,7 +186,7 @@ documentation for the <a class="reference external" href="https://ngrok.com/docs
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">try</span><span class="p">:</span>
<span class="n">c</span><span class="o">.</span><span class="n">ip_policies</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">action</span><span class="o">=</span><span class="s2">"something invalid"</span><span class="p">)</span>
<span class="k">except</span> <span class="n">ngrok</span><span class="o">.</span><span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">error_code</span> <span class="o">==</span> <span class="mi">1410</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">error_code</span> <span class="o">==</span> <span class="s2">"ERR_NGROK_1410"</span><span class="p">:</span>
<span class="c1"># handle a specific condition</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span>
@@ -220,6 +220,12 @@ to introspect the error and take action on it.</p>
</ul>
</dd>
</dl>
<dl class="py method">
<dt id="ngrok.Error.operation_id">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">operation_id</span></code><a class="headerlink" href="#ngrok.Error.operation_id" title="Permalink to this definition"></a></dt>
<dd><p>OperationID returns the unique trace ID assigned by ngrok to this API
request.</p>
</dd></dl>
</dd></dl>
<dl class="py exception">
<dt id="ngrok.NotFoundError">
@@ -243,14 +249,14 @@ This is a separate class to make this common condition easier to handle.</p>
</div>
<svg><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="objects.html">
<a class="prev-page" href="datatypes.html">
<svg><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Objects</div>
<div class="title">Datatypes</div>
</div>
</a>
docs/event_destinations.html
+24 -11
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -178,11 +178,14 @@
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human-readable description of the Event Destination. Optional, max 255 bytes.</p></li>
<li><p><strong>format</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code class="docutils literal notranslate"><span class="pre">JSON</span></code>.</p></li>
<li><p><strong>target</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EventTarget" title="ngrok.objects.EventTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTarget</span></code></a>]) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code class="docutils literal notranslate"><span class="pre">kinesis</span></code>, <code class="docutils literal notranslate"><span class="pre">firehose</span></code>, <code class="docutils literal notranslate"><span class="pre">cloudwatch_logs</span></code>, or <code class="docutils literal notranslate"><span class="pre">s3</span></code>.</p></li>
<li><p><strong>target</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EventTarget" title="ngrok.datatypes.EventTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTarget</span></code></a>]) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code class="docutils literal notranslate"><span class="pre">kinesis</span></code>, <code class="docutils literal notranslate"><span class="pre">firehose</span></code>, <code class="docutils literal notranslate"><span class="pre">cloudwatch_logs</span></code>, or <code class="docutils literal notranslate"><span class="pre">s3</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventDestination" title="ngrok.objects.EventDestination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestination</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-destinations-create">https://ngrok.com/docs/api#api-event-destinations-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventDestination" title="ngrok.datatypes.EventDestination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestination</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -195,6 +198,7 @@
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-destinations-delete">https://ngrok.com/docs/api#api-event-destinations-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EventDestinationsClient.get">
@@ -204,8 +208,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventDestination" title="ngrok.objects.EventDestination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestination</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-destinations-get">https://ngrok.com/docs/api#api-event-destinations-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventDestination" title="ngrok.datatypes.EventDestination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestination</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -220,8 +227,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventDestinationList" title="ngrok.objects.EventDestinationList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestinationList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-destinations-list">https://ngrok.com/docs/api#api-event-destinations-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventDestinationList" title="ngrok.datatypes.EventDestinationList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestinationList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -236,11 +246,14 @@
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – Human-readable description of the Event Destination. Optional, max 255 bytes.</p></li>
<li><p><strong>format</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code class="docutils literal notranslate"><span class="pre">JSON</span></code>.</p></li>
<li><p><strong>target</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.EventTarget" title="ngrok.objects.EventTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTarget</span></code></a>]) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code class="docutils literal notranslate"><span class="pre">kinesis</span></code>, <code class="docutils literal notranslate"><span class="pre">firehose</span></code>, <code class="docutils literal notranslate"><span class="pre">cloudwatch_logs</span></code>, or <code class="docutils literal notranslate"><span class="pre">s3</span></code>.</p></li>
<li><p><strong>target</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.EventTarget" title="ngrok.datatypes.EventTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTarget</span></code></a>]) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code class="docutils literal notranslate"><span class="pre">kinesis</span></code>, <code class="docutils literal notranslate"><span class="pre">firehose</span></code>, <code class="docutils literal notranslate"><span class="pre">cloudwatch_logs</span></code>, or <code class="docutils literal notranslate"><span class="pre">s3</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventDestination" title="ngrok.objects.EventDestination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestination</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-destinations-update">https://ngrok.com/docs/api#api-event-destinations-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventDestination" title="ngrok.datatypes.EventDestination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestination</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/event_streams.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -183,8 +183,11 @@
<li><p><strong>sampling_rate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventStream" title="ngrok.objects.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-create">https://ngrok.com/docs/api#api-event-streams-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventStream" title="ngrok.datatypes.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -197,6 +200,7 @@
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-delete">https://ngrok.com/docs/api#api-event-streams-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EventStreamsClient.get">
@@ -206,8 +210,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventStream" title="ngrok.objects.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-get">https://ngrok.com/docs/api#api-event-streams-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventStream" title="ngrok.datatypes.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -222,8 +229,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventStreamList" title="ngrok.objects.EventStreamList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStreamList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-list">https://ngrok.com/docs/api#api-event-streams-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventStreamList" title="ngrok.datatypes.EventStreamList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStreamList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -242,8 +252,11 @@
<li><p><strong>sampling_rate</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventStream" title="ngrok.objects.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-update">https://ngrok.com/docs/api#api-event-streams-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventStream" title="ngrok.datatypes.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/genindex.html
+485 -483
View File
File diff suppressed because it is too large Load Diff
docs/index.html
+2 -2
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -255,7 +255,7 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</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><ul>
<li class="toctree-l2"><a class="reference internal" href="errors.html#handling-errors">Handling Errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="errors.html#module-ngrok">Exception Classes</a></li>
docs/ip_policies.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -180,8 +180,11 @@
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the IP policy action. Supported values are <code class="docutils literal notranslate"><span class="pre">allow</span></code> or <code class="docutils literal notranslate"><span class="pre">deny</span></code></p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPPolicy" title="ngrok.objects.IPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicy</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-policies-create">https://ngrok.com/docs/api#api-ip-policies-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPPolicy" title="ngrok.datatypes.IPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicy</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -194,6 +197,7 @@
<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-ip-policies-delete">https://ngrok.com/docs/api#api-ip-policies-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.IPPoliciesClient.get">
@@ -203,8 +207,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPPolicy" title="ngrok.objects.IPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicy</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-policies-get">https://ngrok.com/docs/api#api-ip-policies-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPPolicy" title="ngrok.datatypes.IPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicy</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -219,8 +226,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPPolicyList" title="ngrok.objects.IPPolicyList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-policies-list">https://ngrok.com/docs/api#api-ip-policies-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPPolicyList" title="ngrok.datatypes.IPPolicyList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -236,8 +246,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPPolicy" title="ngrok.objects.IPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicy</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-policies-update">https://ngrok.com/docs/api#api-ip-policies-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPPolicy" title="ngrok.datatypes.IPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicy</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/ip_policy_rules.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -181,8 +181,11 @@
<li><p><strong>ip_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of the IP policy this IP policy rule will be attached to</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPPolicyRule" title="ngrok.objects.IPPolicyRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRule</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-policy-rules-create">https://ngrok.com/docs/api#api-ip-policy-rules-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPPolicyRule" title="ngrok.datatypes.IPPolicyRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRule</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -195,6 +198,7 @@
<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-ip-policy-rules-delete">https://ngrok.com/docs/api#api-ip-policy-rules-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.IPPolicyRulesClient.get">
@@ -204,8 +208,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPPolicyRule" title="ngrok.objects.IPPolicyRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRule</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-policy-rules-get">https://ngrok.com/docs/api#api-ip-policy-rules-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPPolicyRule" title="ngrok.datatypes.IPPolicyRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRule</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -220,8 +227,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPPolicyRuleList" title="ngrok.objects.IPPolicyRuleList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRuleList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-policy-rules-list">https://ngrok.com/docs/api#api-ip-policy-rules-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPPolicyRuleList" title="ngrok.datatypes.IPPolicyRuleList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRuleList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -238,8 +248,11 @@
<li><p><strong>cidr</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPPolicyRule" title="ngrok.objects.IPPolicyRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRule</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-policy-rules-update">https://ngrok.com/docs/api#api-ip-policy-rules-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPPolicyRule" title="ngrok.datatypes.IPPolicyRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRule</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/ip_restrictions.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -182,8 +182,11 @@
<li><p><strong>ip_policy_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – the set of IP policy identifiers that are used to enforce the restriction</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPRestriction" title="ngrok.objects.IPRestriction"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestriction</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-restrictions-create">https://ngrok.com/docs/api#api-ip-restrictions-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPRestriction" title="ngrok.datatypes.IPRestriction"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestriction</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,6 +199,7 @@
<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-ip-restrictions-delete">https://ngrok.com/docs/api#api-ip-restrictions-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.IPRestrictionsClient.get">
@@ -205,8 +209,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPRestriction" title="ngrok.objects.IPRestriction"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestriction</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-restrictions-get">https://ngrok.com/docs/api#api-ip-restrictions-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPRestriction" title="ngrok.datatypes.IPRestriction"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestriction</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -221,8 +228,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPRestrictionList" title="ngrok.objects.IPRestrictionList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestrictionList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-restrictions-list">https://ngrok.com/docs/api#api-ip-restrictions-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPRestrictionList" title="ngrok.datatypes.IPRestrictionList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestrictionList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -240,8 +250,11 @@
<li><p><strong>ip_policy_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – the set of IP policy identifiers that are used to enforce the restriction</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPRestriction" title="ngrok.objects.IPRestriction"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestriction</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-restrictions-update">https://ngrok.com/docs/api#api-ip-restrictions-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPRestriction" title="ngrok.datatypes.IPRestriction"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestriction</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/ip_whitelist.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -180,8 +180,11 @@
<li><p><strong>ip_net</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPWhitelistEntry" title="ngrok.objects.IPWhitelistEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistEntry</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-whitelist-create">https://ngrok.com/docs/api#api-ip-whitelist-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPWhitelistEntry" title="ngrok.datatypes.IPWhitelistEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistEntry</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -194,6 +197,7 @@
<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-ip-whitelist-delete">https://ngrok.com/docs/api#api-ip-whitelist-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.IPWhitelistClient.get">
@@ -203,8 +207,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPWhitelistEntry" title="ngrok.objects.IPWhitelistEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistEntry</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-whitelist-get">https://ngrok.com/docs/api#api-ip-whitelist-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPWhitelistEntry" title="ngrok.datatypes.IPWhitelistEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistEntry</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -219,8 +226,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPWhitelistEntryList" title="ngrok.objects.IPWhitelistEntryList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistEntryList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-whitelist-list">https://ngrok.com/docs/api#api-ip-whitelist-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPWhitelistEntryList" title="ngrok.datatypes.IPWhitelistEntryList"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistEntryList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -236,8 +246,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.IPWhitelistEntry" title="ngrok.objects.IPWhitelistEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistEntry</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ip-whitelist-update">https://ngrok.com/docs/api#api-ip-whitelist-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.IPWhitelistEntry" title="ngrok.datatypes.IPWhitelistEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistEntry</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/objects.inv
BIN
View File
Binary file not shown.
docs/py-modindex.html
+2 -2
View File
@@ -109,7 +109,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -182,7 +182,7 @@
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="objects.html#module-ngrok.objects"><code class="xref">ngrok.objects</code></a></td><td>
<a href="datatypes.html#module-ngrok.datatypes"><code class="xref">ngrok.datatypes</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
docs/reserved_addrs.html
+23 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -181,8 +181,11 @@
<li><p><strong>endpoint_configuration_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.ReservedAddr" title="ngrok.objects.ReservedAddr"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddr</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-reserved-addrs-create">https://ngrok.com/docs/api#api-reserved-addrs-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedAddr" title="ngrok.datatypes.ReservedAddr"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddr</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -195,6 +198,7 @@
<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-reserved-addrs-delete">https://ngrok.com/docs/api#api-reserved-addrs-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.ReservedAddrsClient.delete_endpoint_config">
@@ -205,6 +209,7 @@
<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-reserved-addrs-delete-endpoint-config">https://ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.ReservedAddrsClient.get">
@@ -214,8 +219,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.ReservedAddr" title="ngrok.objects.ReservedAddr"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddr</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-reserved-addrs-get">https://ngrok.com/docs/api#api-reserved-addrs-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedAddr" title="ngrok.datatypes.ReservedAddr"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddr</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -230,8 +238,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.ReservedAddrList" title="ngrok.objects.ReservedAddrList"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddrList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-reserved-addrs-list">https://ngrok.com/docs/api#api-reserved-addrs-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedAddrList" title="ngrok.datatypes.ReservedAddrList"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddrList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -248,8 +259,11 @@
<li><p><strong>endpoint_configuration_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.ReservedAddr" title="ngrok.objects.ReservedAddr"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddr</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-reserved-addrs-update">https://ngrok.com/docs/api#api-reserved-addrs-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedAddr" title="ngrok.datatypes.ReservedAddr"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddr</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/reserved_domains.html
+28 -11
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -182,11 +182,14 @@
<li><p><strong>http_endpoint_configuration_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p></li>
<li><p><strong>https_endpoint_configuration_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p></li>
<li><p><strong>certificate_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_management_policy</span></code>.</p></li>
<li><p><strong>certificate_management_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.ReservedDomainCertPolicy" title="ngrok.objects.ReservedDomainCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertPolicy</span></code></a>]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_id</span></code>.</p></li>
<li><p><strong>certificate_management_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomainCertPolicy" title="ngrok.datatypes.ReservedDomainCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertPolicy</span></code></a>]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_id</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.ReservedDomain" title="ngrok.objects.ReservedDomain"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomain</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-reserved-domains-create">https://ngrok.com/docs/api#api-reserved-domains-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomain" title="ngrok.datatypes.ReservedDomain"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomain</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -199,6 +202,7 @@
<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-reserved-domains-delete">https://ngrok.com/docs/api#api-reserved-domains-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.ReservedDomainsClient.delete_certificate">
@@ -209,6 +213,7 @@
<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-reserved-domains-delete-certificate">https://ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.ReservedDomainsClient.delete_certificate_management_policy">
@@ -219,6 +224,7 @@
<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-reserved-domains-delete-certificate-management-policy">https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.ReservedDomainsClient.delete_http_endpoint_config">
@@ -229,6 +235,7 @@
<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-reserved-domains-delete-http-endpoint-config">https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.ReservedDomainsClient.delete_https_endpoint_config">
@@ -239,6 +246,7 @@
<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-reserved-domains-delete-https-endpoint-config">https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.ReservedDomainsClient.get">
@@ -248,8 +256,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.ReservedDomain" title="ngrok.objects.ReservedDomain"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomain</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-reserved-domains-get">https://ngrok.com/docs/api#api-reserved-domains-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomain" title="ngrok.datatypes.ReservedDomain"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomain</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -264,8 +275,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.ReservedDomainList" title="ngrok.objects.ReservedDomainList"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-reserved-domains-list">https://ngrok.com/docs/api#api-reserved-domains-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomainList" title="ngrok.datatypes.ReservedDomainList"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -282,11 +296,14 @@
<li><p><strong>http_endpoint_configuration_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p></li>
<li><p><strong>https_endpoint_configuration_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p></li>
<li><p><strong>certificate_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_management_policy</span></code>.</p></li>
<li><p><strong>certificate_management_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="objects.html#ngrok.objects.ReservedDomainCertPolicy" title="ngrok.objects.ReservedDomainCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertPolicy</span></code></a>]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_id</span></code>.</p></li>
<li><p><strong>certificate_management_policy</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomainCertPolicy" title="ngrok.datatypes.ReservedDomainCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertPolicy</span></code></a>]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code class="docutils literal notranslate"><span class="pre">certificate_id</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.ReservedDomain" title="ngrok.objects.ReservedDomain"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomain</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-reserved-domains-update">https://ngrok.com/docs/api#api-reserved-domains-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ReservedDomain" title="ngrok.datatypes.ReservedDomain"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomain</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/search.html
+1 -1
View File
@@ -108,7 +108,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
docs/searchindex.js
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/ssh_certificate_authorities.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -182,8 +182,11 @@
<li><p><strong>key_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – the key size to use when creating an RSA key. one of <code class="docutils literal notranslate"><span class="pre">2048</span></code> or <code class="docutils literal notranslate"><span class="pre">4096</span></code></p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCertificateAuthority" title="ngrok.objects.SSHCertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthority</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-certificate-authorities-create">https://ngrok.com/docs/api#api-ssh-certificate-authorities-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority" title="ngrok.datatypes.SSHCertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthority</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -196,6 +199,7 @@
<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-ssh-certificate-authorities-delete">https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.SSHCertificateAuthoritiesClient.get">
@@ -205,8 +209,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCertificateAuthority" title="ngrok.objects.SSHCertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthority</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-certificate-authorities-get">https://ngrok.com/docs/api#api-ssh-certificate-authorities-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority" title="ngrok.datatypes.SSHCertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthority</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -221,8 +228,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCertificateAuthorityList" title="ngrok.objects.SSHCertificateAuthorityList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthorityList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-certificate-authorities-list">https://ngrok.com/docs/api#api-ssh-certificate-authorities-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCertificateAuthorityList" title="ngrok.datatypes.SSHCertificateAuthorityList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthorityList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -238,8 +248,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCertificateAuthority" title="ngrok.objects.SSHCertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthority</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-certificate-authorities-update">https://ngrok.com/docs/api#api-ssh-certificate-authorities-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority" title="ngrok.datatypes.SSHCertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthority</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/ssh_credentials.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -181,8 +181,11 @@
<li><p><strong>public_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the PEM-encoded public key of the SSH keypair that will be used to authenticate</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCredential" title="ngrok.objects.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-credentials-create">https://ngrok.com/docs/api#api-ssh-credentials-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCredential" title="ngrok.datatypes.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -195,6 +198,7 @@
<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-ssh-credentials-delete">https://ngrok.com/docs/api#api-ssh-credentials-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.SSHCredentialsClient.get">
@@ -204,8 +208,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCredential" title="ngrok.objects.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-credentials-get">https://ngrok.com/docs/api#api-ssh-credentials-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCredential" title="ngrok.datatypes.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -220,8 +227,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCredentialList" title="ngrok.objects.SSHCredentialList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredentialList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-credentials-list">https://ngrok.com/docs/api#api-ssh-credentials-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCredentialList" title="ngrok.datatypes.SSHCredentialList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredentialList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -238,8 +248,11 @@
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCredential" title="ngrok.objects.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-credentials-update">https://ngrok.com/docs/api#api-ssh-credentials-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCredential" title="ngrok.datatypes.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/ssh_host_certificates.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -184,8 +184,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHHostCertificate" title="ngrok.objects.SSHHostCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificate</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-host-certificates-create">https://ngrok.com/docs/api#api-ssh-host-certificates-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHHostCertificate" title="ngrok.datatypes.SSHHostCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificate</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -198,6 +201,7 @@
<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-ssh-host-certificates-delete">https://ngrok.com/docs/api#api-ssh-host-certificates-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.SSHHostCertificatesClient.get">
@@ -207,8 +211,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHHostCertificate" title="ngrok.objects.SSHHostCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificate</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-host-certificates-get">https://ngrok.com/docs/api#api-ssh-host-certificates-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHHostCertificate" title="ngrok.datatypes.SSHHostCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificate</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -223,8 +230,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHHostCertificateList" title="ngrok.objects.SSHHostCertificateList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificateList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-host-certificates-list">https://ngrok.com/docs/api#api-ssh-host-certificates-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHHostCertificateList" title="ngrok.datatypes.SSHHostCertificateList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificateList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -240,8 +250,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHHostCertificate" title="ngrok.objects.SSHHostCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificate</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-host-certificates-update">https://ngrok.com/docs/api#api-ssh-host-certificates-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHHostCertificate" title="ngrok.datatypes.SSHHostCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificate</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/ssh_user_certificates.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -186,8 +186,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHUserCertificate" title="ngrok.objects.SSHUserCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificate</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-user-certificates-create">https://ngrok.com/docs/api#api-ssh-user-certificates-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHUserCertificate" title="ngrok.datatypes.SSHUserCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificate</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -200,6 +203,7 @@
<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-ssh-user-certificates-delete">https://ngrok.com/docs/api#api-ssh-user-certificates-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.SSHUserCertificatesClient.get">
@@ -209,8 +213,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHUserCertificate" title="ngrok.objects.SSHUserCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificate</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-user-certificates-get">https://ngrok.com/docs/api#api-ssh-user-certificates-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHUserCertificate" title="ngrok.datatypes.SSHUserCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificate</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -225,8 +232,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHUserCertificateList" title="ngrok.objects.SSHUserCertificateList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificateList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-user-certificates-list">https://ngrok.com/docs/api#api-ssh-user-certificates-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHUserCertificateList" title="ngrok.datatypes.SSHUserCertificateList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificateList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -242,8 +252,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHUserCertificate" title="ngrok.objects.SSHUserCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificate</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-user-certificates-update">https://ngrok.com/docs/api#api-ssh-user-certificates-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHUserCertificate" title="ngrok.datatypes.SSHUserCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificate</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/tls_certificates.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -181,8 +181,11 @@
<li><p><strong>private_key_pem</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – private key for the TLS certificate, PEM-encoded. See <cite>Private Keys</cite> &lt;<a class="reference external" href="https://ngrok.com/docs/ngrok-link#tls-certificates-key">https://ngrok.com/docs/ngrok-link#tls-certificates-key</a>&gt;`_.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.TLSCertificate" title="ngrok.objects.TLSCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificate</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tls-certificates-create">https://ngrok.com/docs/api#api-tls-certificates-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSCertificate" title="ngrok.datatypes.TLSCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificate</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -195,6 +198,7 @@
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tls-certificates-delete">https://ngrok.com/docs/api#api-tls-certificates-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.TLSCertificatesClient.get">
@@ -204,8 +208,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.TLSCertificate" title="ngrok.objects.TLSCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificate</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tls-certificates-get">https://ngrok.com/docs/api#api-tls-certificates-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSCertificate" title="ngrok.datatypes.TLSCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificate</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -220,8 +227,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.TLSCertificateList" title="ngrok.objects.TLSCertificateList"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificateList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tls-certificates-list">https://ngrok.com/docs/api#api-tls-certificates-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSCertificateList" title="ngrok.datatypes.TLSCertificateList"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificateList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -237,8 +247,11 @@
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.TLSCertificate" title="ngrok.objects.TLSCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificate</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tls-certificates-update">https://ngrok.com/docs/api#api-tls-certificates-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.TLSCertificate" title="ngrok.datatypes.TLSCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificate</span></code></a></p>
</dd>
</dl>
</dd></dl>
docs/tunnel_sessions.html
+14 -5
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -176,8 +176,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.TunnelSession" title="ngrok.objects.TunnelSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelSession</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tunnel-sessions-get">https://ngrok.com/docs/api#api-tunnel-sessions-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.TunnelSession" title="ngrok.datatypes.TunnelSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelSession</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -192,8 +195,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.TunnelSessionList" title="ngrok.objects.TunnelSessionList"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelSessionList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tunnel-sessions-list">https://ngrok.com/docs/api#api-tunnel-sessions-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.TunnelSessionList" title="ngrok.datatypes.TunnelSessionList"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelSessionList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -206,6 +212,7 @@
<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-tunnel-sessions-restart">https://ngrok.com/docs/api#api-tunnel-sessions-restart</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.TunnelSessionsClient.stop">
@@ -216,6 +223,7 @@
<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-tunnel-sessions-stop">https://ngrok.com/docs/api#api-tunnel-sessions-stop</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.TunnelSessionsClient.update">
@@ -226,6 +234,7 @@
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p>
</dd>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tunnel-sessions-update">https://ngrok.com/docs/api#api-tunnel-sessions-update</a></p>
</dd></dl>
</dd></dl>
</div>
docs/tunnels.html
+6 -3
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -179,8 +179,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.TunnelList" title="ngrok.objects.TunnelList"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-tunnels-list">https://ngrok.com/docs/api#api-tunnels-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.TunnelList" title="ngrok.datatypes.TunnelList"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelList</span></code></a></p>
</dd>
</dl>
</dd></dl>
ngrok/client.py
+2 -3
View File
@@ -5,9 +5,8 @@ from .services import *
class Client(object):
def __init__(self, api_key: str = "", base_url: str = "https://api.ngrok.com"):
self.api_key = api_key or os.getenv("NGROK_API_KEY")
self.api_client = APIClient(api_key, base_url)
def __init__(self, api_key: str, base_url: str = "https://api.ngrok.com"):
self.http_client = HTTPClient(api_key, base_url)
@property
def abuse_reports(self) -> AbuseReportsClient:
ngrok/objects.py → ngrok/datatypes.py
+380 -148
View File
@@ -11,8 +11,11 @@ class Ref(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<Ref {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<Ref {} {}>".format(self.id, repr(self._props))
else:
return "<Ref {}>".format(repr(self._props))
@property
def id(self) -> str:
@@ -36,8 +39,11 @@ class AbuseReport(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<AbuseReport {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<AbuseReport {} {}>".format(self.id, repr(self._props))
else:
return "<AbuseReport {}>".format(repr(self._props))
@property
def id(self) -> str:
@@ -83,8 +89,11 @@ class AbuseReportHostname(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<AbuseReportHostname {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<AbuseReportHostname {} {}>".format(self.id, repr(self._props))
else:
return "<AbuseReportHostname {}>".format(repr(self._props))
@property
def hostname(self) -> str:
@@ -105,8 +114,11 @@ class APIKey(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<APIKey {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<APIKey {} {}>".format(self.id, repr(self._props))
else:
return "<APIKey {}>".format(repr(self._props))
def delete(
self,
@@ -166,8 +178,11 @@ class APIKeyList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<APIKeyList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<APIKeyList {} {}>".format(self.id, repr(self._props))
else:
return "<APIKeyList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "keys")
@@ -196,8 +211,11 @@ class CertificateAuthority(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<CertificateAuthority {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<CertificateAuthority {} {}>".format(self.id, repr(self._props))
else:
return "<CertificateAuthority {}>".format(repr(self._props))
def delete(
self,
@@ -284,8 +302,11 @@ class CertificateAuthorityList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<CertificateAuthorityList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<CertificateAuthorityList {} {}>".format(self.id, repr(self._props))
else:
return "<CertificateAuthorityList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "certificate_authorities")
@@ -314,8 +335,11 @@ class Credential(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<Credential {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<Credential {} {}>".format(self.id, repr(self._props))
else:
return "<Credential {}>".format(repr(self._props))
def delete(
self,
@@ -384,8 +408,11 @@ class CredentialList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<CredentialList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<CredentialList {} {}>".format(self.id, repr(self._props))
else:
return "<CredentialList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "credentials")
@@ -417,8 +444,11 @@ class EventStreamList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EventStreamList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EventStreamList {} {}>".format(self.id, repr(self._props))
else:
return "<EventStreamList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "event_streams")
@@ -447,8 +477,11 @@ class EventStream(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EventStream {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EventStream {} {}>".format(self.id, repr(self._props))
else:
return "<EventStream {}>".format(repr(self._props))
def delete(
self,
@@ -529,8 +562,11 @@ class EventDestination(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EventDestination {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EventDestination {} {}>".format(self.id, repr(self._props))
else:
return "<EventDestination {}>".format(repr(self._props))
def delete(
self,
@@ -586,8 +622,11 @@ class EventDestinationList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EventDestinationList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EventDestinationList {} {}>".format(self.id, repr(self._props))
else:
return "<EventDestinationList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "event_destinations")
@@ -621,8 +660,11 @@ class EventTarget(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EventTarget {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EventTarget {} {}>".format(self.id, repr(self._props))
else:
return "<EventTarget {}>".format(repr(self._props))
@property
def firehose(self) -> EventTargetFirehose:
@@ -649,8 +691,11 @@ class EventTargetFirehose(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EventTargetFirehose {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EventTargetFirehose {} {}>".format(self.id, repr(self._props))
else:
return "<EventTargetFirehose {}>".format(repr(self._props))
@property
def auth(self) -> AWSAuth:
@@ -672,8 +717,11 @@ class EventTargetKinesis(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EventTargetKinesis {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EventTargetKinesis {} {}>".format(self.id, repr(self._props))
else:
return "<EventTargetKinesis {}>".format(repr(self._props))
@property
def auth(self) -> AWSAuth:
@@ -695,8 +743,13 @@ class EventTargetCloudwatchLogs(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EventTargetCloudwatchLogs {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EventTargetCloudwatchLogs {} {}>".format(
self.id, repr(self._props)
)
else:
return "<EventTargetCloudwatchLogs {}>".format(repr(self._props))
@property
def auth(self) -> AWSAuth:
@@ -719,8 +772,11 @@ class AWSAuth(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<AWSAuth {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<AWSAuth {} {}>".format(self.id, repr(self._props))
else:
return "<AWSAuth {}>".format(repr(self._props))
@property
def role(self) -> AWSRole:
@@ -741,8 +797,11 @@ class AWSRole(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<AWSRole {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<AWSRole {} {}>".format(self.id, repr(self._props))
else:
return "<AWSRole {}>".format(repr(self._props))
@property
def role_arn(self) -> str:
@@ -758,8 +817,11 @@ class AWSCredentials(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<AWSCredentials {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<AWSCredentials {} {}>".format(self.id, repr(self._props))
else:
return "<AWSCredentials {}>".format(repr(self._props))
@property
def aws_access_key_id(self) -> str:
@@ -780,8 +842,11 @@ class IPPolicy(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<IPPolicy {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<IPPolicy {} {}>".format(self.id, repr(self._props))
else:
return "<IPPolicy {}>".format(repr(self._props))
def delete(
self,
@@ -841,8 +906,11 @@ class IPPolicyList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<IPPolicyList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<IPPolicyList {} {}>".format(self.id, repr(self._props))
else:
return "<IPPolicyList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ip_policies")
@@ -872,8 +940,11 @@ class IPPolicyRule(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<IPPolicyRule {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<IPPolicyRule {} {}>".format(self.id, repr(self._props))
else:
return "<IPPolicyRule {}>".format(repr(self._props))
def delete(
self,
@@ -942,8 +1013,11 @@ class IPPolicyRuleList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<IPPolicyRuleList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<IPPolicyRuleList {} {}>".format(self.id, repr(self._props))
else:
return "<IPPolicyRuleList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ip_policy_rules")
@@ -973,8 +1047,11 @@ class IPRestriction(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<IPRestriction {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<IPRestriction {} {}>".format(self.id, repr(self._props))
else:
return "<IPRestriction {}>".format(repr(self._props))
def delete(
self,
@@ -1035,8 +1112,11 @@ class IPRestrictionList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<IPRestrictionList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<IPRestrictionList {} {}>".format(self.id, repr(self._props))
else:
return "<IPRestrictionList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ip_restrictions")
@@ -1065,8 +1145,11 @@ class IPWhitelistEntry(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<IPWhitelistEntry {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<IPWhitelistEntry {} {}>".format(self.id, repr(self._props))
else:
return "<IPWhitelistEntry {}>".format(repr(self._props))
def delete(
self,
@@ -1128,8 +1211,11 @@ class IPWhitelistEntryList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<IPWhitelistEntryList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<IPWhitelistEntryList {} {}>".format(self.id, repr(self._props))
else:
return "<IPWhitelistEntryList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "whitelist")
@@ -1180,8 +1266,11 @@ class EndpointConfiguration(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointConfiguration {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointConfiguration {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointConfiguration {}>".format(repr(self._props))
def delete(
self,
@@ -1327,8 +1416,13 @@ class EndpointConfigurationList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointConfigurationList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointConfigurationList {} {}>".format(
self.id, repr(self._props)
)
else:
return "<EndpointConfigurationList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "endpoint_configurations")
@@ -1357,8 +1451,13 @@ class EndpointWebhookValidation(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointWebhookValidation {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointWebhookValidation {} {}>".format(
self.id, repr(self._props)
)
else:
return "<EndpointWebhookValidation {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1384,8 +1483,11 @@ class EndpointCompression(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointCompression {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointCompression {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointCompression {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1404,8 +1506,11 @@ class EndpointMutualTLS(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointMutualTLS {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointMutualTLS {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointMutualTLS {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1426,8 +1531,11 @@ class EndpointMutualTLSMutate(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointMutualTLSMutate {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointMutualTLSMutate {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointMutualTLSMutate {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1448,8 +1556,11 @@ class EndpointTLSTermination(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointTLSTermination {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointTLSTermination {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointTLSTermination {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1476,8 +1587,11 @@ class EndpointLogging(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointLogging {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointLogging {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointLogging {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1498,8 +1612,11 @@ class EndpointLoggingMutate(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointLoggingMutate {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointLoggingMutate {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointLoggingMutate {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1520,8 +1637,11 @@ class EndpointRequestHeaders(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointRequestHeaders {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointRequestHeaders {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointRequestHeaders {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1547,8 +1667,11 @@ class EndpointResponseHeaders(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointResponseHeaders {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointResponseHeaders {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointResponseHeaders {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1575,8 +1698,11 @@ class EndpointIPPolicy(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointIPPolicy {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointIPPolicy {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointIPPolicy {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1596,8 +1722,11 @@ class EndpointIPPolicyMutate(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointIPPolicyMutate {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointIPPolicyMutate {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointIPPolicyMutate {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1618,8 +1747,11 @@ class EndpointCircuitBreaker(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointCircuitBreaker {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointCircuitBreaker {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointCircuitBreaker {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1661,8 +1793,11 @@ class EndpointOAuth(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointOAuth {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointOAuth {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointOAuth {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1712,8 +1847,11 @@ class EndpointOAuthProvider(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointOAuthProvider {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointOAuthProvider {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointOAuthProvider {}>".format(repr(self._props))
@property
def github(self) -> EndpointOAuthGitHub:
@@ -1744,8 +1882,11 @@ class EndpointOAuthGitHub(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointOAuthGitHub {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointOAuthGitHub {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointOAuthGitHub {}>".format(repr(self._props))
@property
def client_id(self) -> str:
@@ -1791,8 +1932,11 @@ class EndpointOAuthFacebook(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointOAuthFacebook {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointOAuthFacebook {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointOAuthFacebook {}>".format(repr(self._props))
@property
def client_id(self) -> str:
@@ -1828,8 +1972,11 @@ class EndpointOAuthMicrosoft(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointOAuthMicrosoft {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointOAuthMicrosoft {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointOAuthMicrosoft {}>".format(repr(self._props))
@property
def client_id(self) -> str:
@@ -1865,8 +2012,11 @@ class EndpointOAuthGoogle(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointOAuthGoogle {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointOAuthGoogle {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointOAuthGoogle {}>".format(repr(self._props))
@property
def client_id(self) -> str:
@@ -1902,8 +2052,11 @@ class EndpointSAML(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointSAML {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointSAML {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointSAML {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1984,8 +2137,11 @@ class EndpointSAMLMutate(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointSAMLMutate {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointSAMLMutate {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointSAMLMutate {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -2041,8 +2197,11 @@ class EndpointOIDC(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<EndpointOIDC {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<EndpointOIDC {} {}>".format(self.id, repr(self._props))
else:
return "<EndpointOIDC {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -2101,8 +2260,11 @@ class ReservedAddr(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<ReservedAddr {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<ReservedAddr {} {}>".format(self.id, repr(self._props))
else:
return "<ReservedAddr {}>".format(repr(self._props))
def delete(
self,
@@ -2163,8 +2325,11 @@ class ReservedAddrList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<ReservedAddrList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<ReservedAddrList {} {}>".format(self.id, repr(self._props))
else:
return "<ReservedAddrList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "reserved_addrs")
@@ -2206,8 +2371,11 @@ class ReservedDomain(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<ReservedDomain {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<ReservedDomain {} {}>".format(self.id, repr(self._props))
else:
return "<ReservedDomain {}>".format(repr(self._props))
def delete(
self,
@@ -2293,8 +2461,11 @@ class ReservedDomainList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<ReservedDomainList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<ReservedDomainList {} {}>".format(self.id, repr(self._props))
else:
return "<ReservedDomainList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "reserved_domains")
@@ -2323,8 +2494,11 @@ class ReservedDomainCertPolicy(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<ReservedDomainCertPolicy {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<ReservedDomainCertPolicy {} {}>".format(self.id, repr(self._props))
else:
return "<ReservedDomainCertPolicy {}>".format(repr(self._props))
@property
def authority(self) -> str:
@@ -2348,8 +2522,11 @@ class ReservedDomainCertStatus(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<ReservedDomainCertStatus {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<ReservedDomainCertStatus {} {}>".format(self.id, repr(self._props))
else:
return "<ReservedDomainCertStatus {}>".format(repr(self._props))
@property
def renews_at(self) -> str:
@@ -2370,8 +2547,13 @@ class ReservedDomainCertNSTarget(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<ReservedDomainCertNSTarget {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<ReservedDomainCertNSTarget {} {}>".format(
self.id, repr(self._props)
)
else:
return "<ReservedDomainCertNSTarget {}>".format(repr(self._props))
@property
def zone(self) -> str:
@@ -2395,8 +2577,11 @@ class ReservedDomainCertJob(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<ReservedDomainCertJob {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<ReservedDomainCertJob {} {}>".format(self.id, repr(self._props))
else:
return "<ReservedDomainCertJob {}>".format(repr(self._props))
@property
def error_code(self) -> str:
@@ -2432,8 +2617,11 @@ class SSHCertificateAuthority(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<SSHCertificateAuthority {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<SSHCertificateAuthority {} {}>".format(self.id, repr(self._props))
else:
return "<SSHCertificateAuthority {}>".format(repr(self._props))
def delete(
self,
@@ -2501,8 +2689,13 @@ class SSHCertificateAuthorityList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<SSHCertificateAuthorityList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<SSHCertificateAuthorityList {} {}>".format(
self.id, repr(self._props)
)
else:
return "<SSHCertificateAuthorityList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ssh_certificate_authorities")
@@ -2531,8 +2724,11 @@ class SSHCredential(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<SSHCredential {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<SSHCredential {} {}>".format(self.id, repr(self._props))
else:
return "<SSHCredential {}>".format(repr(self._props))
def delete(
self,
@@ -2601,8 +2797,11 @@ class SSHCredentialList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<SSHCredentialList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<SSHCredentialList {} {}>".format(self.id, repr(self._props))
else:
return "<SSHCredentialList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ssh_credentials")
@@ -2631,8 +2830,11 @@ class SSHHostCertificate(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<SSHHostCertificate {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<SSHHostCertificate {} {}>".format(self.id, repr(self._props))
else:
return "<SSHHostCertificate {}>".format(repr(self._props))
def delete(
self,
@@ -2724,8 +2926,11 @@ class SSHHostCertificateList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<SSHHostCertificateList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<SSHHostCertificateList {} {}>".format(self.id, repr(self._props))
else:
return "<SSHHostCertificateList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ssh_host_certificates")
@@ -2754,8 +2959,11 @@ class SSHUserCertificate(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<SSHUserCertificate {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<SSHUserCertificate {} {}>".format(self.id, repr(self._props))
else:
return "<SSHUserCertificate {}>".format(repr(self._props))
def delete(
self,
@@ -2857,8 +3065,11 @@ class SSHUserCertificateList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<SSHUserCertificateList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<SSHUserCertificateList {} {}>".format(self.id, repr(self._props))
else:
return "<SSHUserCertificateList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ssh_user_certificates")
@@ -2890,8 +3101,11 @@ class TLSCertificate(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<TLSCertificate {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<TLSCertificate {} {}>".format(self.id, repr(self._props))
else:
return "<TLSCertificate {}>".format(repr(self._props))
def delete(
self,
@@ -3028,8 +3242,11 @@ class TLSCertificateList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<TLSCertificateList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<TLSCertificateList {} {}>".format(self.id, repr(self._props))
else:
return "<TLSCertificateList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "tls_certificates")
@@ -3058,8 +3275,11 @@ class TLSCertificateSANs(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<TLSCertificateSANs {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<TLSCertificateSANs {} {}>".format(self.id, repr(self._props))
else:
return "<TLSCertificateSANs {}>".format(repr(self._props))
@property
def dns_names(self) -> Sequence[str]:
@@ -3081,8 +3301,11 @@ class TunnelSession(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<TunnelSession {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<TunnelSession {} {}>".format(self.id, repr(self._props))
else:
return "<TunnelSession {}>".format(repr(self._props))
@property
def agent_version(self) -> str:
@@ -3146,8 +3369,11 @@ class TunnelSessionList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<TunnelSessionList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<TunnelSessionList {} {}>".format(self.id, repr(self._props))
else:
return "<TunnelSessionList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "tunnel_sessions")
@@ -3177,8 +3403,11 @@ class Tunnel(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<Tunnel {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<Tunnel {} {}>".format(self.id, repr(self._props))
else:
return "<Tunnel {}>".format(repr(self._props))
@property
def id(self) -> str:
@@ -3225,8 +3454,11 @@ class TunnelList(object):
def __eq__(self, other):
return self._props == other._props
def __repr__(self):
return "<TunnelList {}>".format(self.id)
def __str__(self):
if "id" in self._props:
return "<TunnelList {} {}>".format(self.id, repr(self._props))
else:
return "<TunnelList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "tunnels")
ngrok/error.py
+8
View File
@@ -25,6 +25,14 @@ class Error(Exception):
self.http_status_code = http_status_code
self.details = details
@property
def operation_id(self):
"""
OperationID returns the unique trace ID assigned by ngrok to this API
request.
"""
return self.details.get("operation_id")
class NotFoundError(Error):
"""Raised if the http_status_code of an API operation is 404.
ngrok/api_client.py → ngrok/http_client.py
+6 -1
View File
@@ -7,7 +7,12 @@ import requests
from .error import Error, NotFoundError
class APIClient(object):
class HTTPClient(object):
"""low-level api client for communicating with ngrok's http api.
do not use this object directly, it is intended for internal use only and no
guarantees are made about the stability of its APIs
"""
def __init__(self, api_key: str, base_url: str):
self.api_key = api_key
self.base_url = base_url
ngrok/iterator.py
+1 -1
View File
@@ -14,7 +14,7 @@ class PagedIterator(object):
if self.page.next_page_uri is None:
raise StopIteration
else:
props = self.client.api_client.request("get", self.page.next_page_uri)
props = self.client.http_client.request("get", self.page.next_page_uri)
self.n = 0
self.page = self.page.__class__(self.client, props)
return self.__next__()
ngrok/services.py
+404 -136
View File
File diff suppressed because it is too large Load Diff
setup.py
+2 -2
View File
@@ -8,7 +8,7 @@ def read_file(filename):
setup(
name="ngrok-api",
version="0.1.2",
version="0.1.3",
description="ngrok HTTP API client library",
long_description=read_file("README.md"),
long_description_content_type="text/markdown",
@@ -23,7 +23,7 @@ setup(
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires=">=3.8",
python_requires=">=3.7",
install_requires=[
"requests==2.25.1",
],
tests/test_ngrok.py
+10 -10
View File
@@ -1,17 +1,17 @@
import ngrok
import ngrok.api_client
import ngrok.http_client
import json
import os
from typing import Optional, Mapping, Union, Dict, Any
def test_certificate_authorities():
c = ngrok.Client()
c = ngrok.Client(os.getenv("NGROK_API_KEY"))
mock = MockAPIClient()
if os.getenv('TEST_RECORD', False):
c.api_client = RecordingAPIClient(c.api_client.api_key, c.api_client.base_url)
if os.getenv('TEST_MOCK', False):
c.api_client = mock
mock = MockHTTPClient()
if not os.getenv('TEST_NO_MOCK', False):
c.http_client = mock
elif os.getenv('TEST_DEBUG', False):
c.http_client = RecordingHTTPClient(c.http_client.api_key, c.http_client.base_url)
mock.returns(mock_empty_ca_list)
c.certificate_authorities.list()
@@ -95,14 +95,14 @@ mock_ca_list = """
{"certificate_authorities": ["""+mock_ca_updated+"""], "uri": "https://api.ngrok.com/certificate_authorities", "next_page_uri": null}
"""
class RecordingAPIClient(ngrok.api_client.APIClient):
class RecordingHTTPClient(ngrok.http_client.HTTPClient):
""" prints all responses received to stdout, useful for creating mocked outputs """
def do(self, method: str, path: str, query_params: Mapping[str, str] = None, payload: Mapping[str, Any] = None) -> Optional[Dict[str, Any]]:
ret = super(RecordingAPIClient, self).do(method, path, query_params, payload)
ret = super(RecordingHTTPClient, self).do(method, path, query_params, payload)
print(json.dumps(ret))
return ret
class MockAPIClient(ngrok.api_client.APIClient):
class MockHTTPClient(ngrok.http_client.HTTPClient):
def __init__(self):
pass
tox.ini
+5 -6
View File
@@ -1,16 +1,15 @@
[tox]
envlist = py38
minversion = 3.23.0
skip_missing_interpreters = true
#skip_missing_interpreters = true
[testenv]
# uncomment this along with commenting out TEST_MOCK
# uncomment out to test against the live API
#setenv = TEST_NO_MOCK=true
# uncomment this along with uncommenting TEST_NO_MOCK
# to capture live responses from the live API to aid in creating
# mocks
#setenv = TEST_RECORD=true
# comment out to test against the live API
setenv = TEST_MOCK=true
#setenv = TEST_DEBUG=true
passenv = NGROK_API_KEY
deps =
pytest==6.2.3