mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-05-17 16:50:36 +00:00
Merge pull request #46 from ngrok/pr/generated-0ead35021d
Update generated files
This commit is contained in:
@@ -1,4 +1,8 @@
|
||||
<!-- Code generated for API Clients. DO NOT EDIT. -->
|
||||
## 0.15.0
|
||||
* Add support for `vaults`
|
||||
* Add support for `secrets`
|
||||
|
||||
## 0.14.0
|
||||
* Renamed `upstream_proto` to `upstream_protocol` for `endpoint` resources
|
||||
* Added support for `pooling_enabled` on Endpoints
|
||||
|
||||
@@ -173,9 +173,11 @@ API Reference
|
||||
ip_restrictions
|
||||
reserved_addrs
|
||||
reserved_domains
|
||||
secrets
|
||||
ssh_certificate_authorities
|
||||
ssh_credentials
|
||||
ssh_host_certificates
|
||||
ssh_user_certificates
|
||||
tls_certificates
|
||||
tunnels
|
||||
vaults
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Secrets
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.secrets` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: SecretsClient
|
||||
:undoc-members: SecretsClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Vaults
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.vaults` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: VaultsClient
|
||||
:undoc-members: VaultsClient
|
||||
@@ -211,12 +211,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,12 +211,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -377,6 +379,11 @@
|
||||
<span class="sd"> This CNAME record points traffic for that domain to ngrok's edge servers."""</span>
|
||||
<span class="k">return</span> <span class="n">ReservedDomainsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">secrets</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SecretsClient</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""</span>
|
||||
<span class="k">return</span> <span class="n">SecretsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">ssh_certificate_authorities</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SSHCertificateAuthoritiesClient</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""An SSH Certificate Authority is a pair of an SSH Certificate and its private</span>
|
||||
@@ -418,6 +425,11 @@
|
||||
<span class="sd"> agent tunnel session or an SSH reverse tunnel session."""</span>
|
||||
<span class="k">return</span> <span class="n">TunnelsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">vaults</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">VaultsClient</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""</span>
|
||||
<span class="k">return</span> <span class="n">VaultsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">backends</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">ns</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span>
|
||||
|
||||
@@ -211,12 +211,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -5358,6 +5360,128 @@
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"retries_at"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Secret"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.Secret">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">Secret</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"created_by"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="n">Ref</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">"created_by"</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"created_by"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"last_updated_by"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="n">Ref</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">"last_updated_by"</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"last_updated_by"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"vault"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="n">Ref</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">"vault"</span><span class="p">])</span> <span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"vault"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<Secret </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<Secret </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<div class="viewcode-block" id="Secret.delete"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.Secret.delete">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">secrets</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""identifier for Secret"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"id"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of this Secret API resource"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">created_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Timestamp when the Secret was created (RFC 3339 format)"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"created_at"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">updated_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Timestamp when the Secret was last updated (RFC 3339 format)"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"updated_at"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Name of secret"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""description of Secret"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Arbitrary user-defined metadata for this Secret"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"metadata"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">created_by</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Ref</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Reference to who created this Secret"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"created_by"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">last_updated_by</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Ref</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Reference to who created this Secret"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"last_updated_by"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">vault</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Ref</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Reference to the vault the secret is stored in"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"vault"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SecretList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.SecretList">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">SecretList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"secrets"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="p">[</span><span class="n">Secret</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">"secrets"</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"secrets"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="p">[]</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<SecretList </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<SecretList </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">PagedIterator</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">"secrets"</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">secrets</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Secret</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""The list of Secrets for this account"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"secrets"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">next_page_uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the next page of results, or null if there is no next page"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"next_page_uri"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SSHCertificateAuthority"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.SSHCertificateAuthority">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">SSHCertificateAuthority</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
@@ -6181,6 +6305,123 @@
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">next_page_uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the next page, or null if there is no next page"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"next_page_uri"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Vault"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.Vault">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">Vault</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<Vault </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<Vault </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<div class="viewcode-block" id="Vault.update"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.Vault.update">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">vaults</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Vault.delete"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.Vault.delete">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">vaults</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""identifier for Vault"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"id"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of this Vault API resource"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">created_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Timestamp when the Vault was created (RFC 3339 format)"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"created_at"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">updated_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Timestamp when the Vault was last updated (RFC 3339 format)"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"updated_at"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Name of vault"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""description of Vault"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Arbitrary user-defined metadata for this Vault"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"metadata"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">created_by</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Reference to who created this Vault"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"created_by"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">last_updated_by</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Reference to who created this Vault"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"last_updated_by"</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="VaultList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.VaultList">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">VaultList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"vaults"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="p">[</span><span class="n">Vault</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">"vaults"</span><span class="p">]]</span>
|
||||
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"vaults"</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
|
||||
<span class="k">else</span> <span class="p">[]</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="s2">"id"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<VaultList </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">"<VaultList </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">PagedIterator</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">"vaults"</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">vaults</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Vault</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""The list of Vaults for this account"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"vaults"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">next_page_uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the next page of results, or null if there is no next page"""</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">"next_page_uri"</span><span class="p">]</span></div>
|
||||
</pre></div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -211,12 +211,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -211,12 +211,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -4870,6 +4872,128 @@
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SecretsClient"><a class="viewcode-back" href="../../secrets.html#ngrok.services.SecretsClient">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">SecretsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
|
||||
<div class="viewcode-block" id="SecretsClient.create"><a class="viewcode-back" href="../../secrets.html#ngrok.services.SecretsClient.create">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">create</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">vault_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Secret</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create a new Secret</span>
|
||||
|
||||
<span class="sd"> :param name: Name of secret</span>
|
||||
<span class="sd"> :param value: Value of secret</span>
|
||||
<span class="sd"> :param metadata: Arbitrary user-defined metadata for this Secret</span>
|
||||
<span class="sd"> :param description: description of Secret</span>
|
||||
<span class="sd"> :param vault_id: unique identifier of the referenced vault</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-secrets-create</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vault_secrets"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="n">vault_id</span><span class="o">=</span><span class="n">vault_id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Secret</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="SecretsClient.update"><a class="viewcode-back" href="../../secrets.html#ngrok.services.SecretsClient.update">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Secret</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Update an existing Secret by ID</span>
|
||||
|
||||
<span class="sd"> :param id: identifier for Secret</span>
|
||||
<span class="sd"> :param name: Name of secret</span>
|
||||
<span class="sd"> :param value: Value of secret</span>
|
||||
<span class="sd"> :param metadata: Arbitrary user-defined metadata for this Secret</span>
|
||||
<span class="sd"> :param description: description of Secret</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-secrets-update</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vault_secrets/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Secret</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="SecretsClient.delete"><a class="viewcode-back" href="../../secrets.html#ngrok.services.SecretsClient.delete">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Delete a Secret</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-secrets-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vault_secrets/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="SecretsClient.get"><a class="viewcode-back" href="../../secrets.html#ngrok.services.SecretsClient.get">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">get</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Secret</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get a Secret by ID</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-secrets-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vault_secrets/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Secret</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="SecretsClient.list"><a class="viewcode-back" href="../../secrets.html#ngrok.services.SecretsClient.list">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">list</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">SecretList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all Secrets owned by account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-secrets-list</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vault_secrets"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">SecretList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SSHCertificateAuthoritiesClient"><a class="viewcode-back" href="../../ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">SSHCertificateAuthoritiesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""An SSH Certificate Authority is a pair of an SSH Certificate and its private</span>
|
||||
<span class="sd"> key that can be used to sign other SSH host and user certificates."""</span>
|
||||
@@ -5522,6 +5646,119 @@
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Tunnel</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="VaultsClient"><a class="viewcode-back" href="../../vaults.html#ngrok.services.VaultsClient">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">VaultsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
|
||||
<div class="viewcode-block" id="VaultsClient.create"><a class="viewcode-back" href="../../vaults.html#ngrok.services.VaultsClient.create">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">create</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Vault</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Create a new Vault</span>
|
||||
|
||||
<span class="sd"> :param name: Name of vault</span>
|
||||
<span class="sd"> :param metadata: Arbitrary user-defined metadata for this Vault</span>
|
||||
<span class="sd"> :param description: description of Vault</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-vaults-create</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vaults"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Vault</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="VaultsClient.update"><a class="viewcode-back" href="../../vaults.html#ngrok.services.VaultsClient.update">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Vault</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Update an existing Vault by ID</span>
|
||||
|
||||
<span class="sd"> :param id: identifier for Vault</span>
|
||||
<span class="sd"> :param name: Name of vault</span>
|
||||
<span class="sd"> :param metadata: Arbitrary user-defined metadata for this Vault</span>
|
||||
<span class="sd"> :param description: description of Vault</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-vaults-update</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vaults/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
||||
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Vault</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="VaultsClient.delete"><a class="viewcode-back" href="../../vaults.html#ngrok.services.VaultsClient.delete">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">delete</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Delete a Vault</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-vaults-delete</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vaults/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="VaultsClient.get"><a class="viewcode-back" href="../../vaults.html#ngrok.services.VaultsClient.get">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">get</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Vault</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get a Vault by ID</span>
|
||||
|
||||
<span class="sd"> :param id: a resource identifier</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-vaults-get</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vaults/</span><span class="si">{id}</span><span class="s2">"</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Vault</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="VaultsClient.list"><a class="viewcode-back" href="../../vaults.html#ngrok.services.VaultsClient.list">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">list</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">VaultList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all Vaults owned by account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-vaults-list</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/vaults"</span>
|
||||
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
|
||||
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">VaultList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
||||
</pre></div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -173,9 +173,11 @@ API Reference
|
||||
ip_restrictions
|
||||
reserved_addrs
|
||||
reserved_domains
|
||||
secrets
|
||||
ssh_certificate_authorities
|
||||
ssh_credentials
|
||||
ssh_host_certificates
|
||||
ssh_user_certificates
|
||||
tls_certificates
|
||||
tunnels
|
||||
vaults
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Secrets
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.secrets` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: SecretsClient
|
||||
:undoc-members: SecretsClient
|
||||
@@ -0,0 +1,12 @@
|
||||
..
|
||||
Code generated for API Clients. DO NOT EDIT.
|
||||
|
||||
Vaults
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.vaults` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: VaultsClient
|
||||
:undoc-members: VaultsClient
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -497,6 +499,17 @@ This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.Client.secrets">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">secrets</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient" title="ngrok.services.SecretsClient"><span class="pre">SecretsClient</span></a></em><a class="headerlink" href="#ngrok.Client.secrets" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient" title="ngrok.services.SecretsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SecretsClient</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.Client.ssh_certificate_authorities">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ssh_certificate_authorities</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient" title="ngrok.services.SSHCertificateAuthoritiesClient"><span class="pre">SSHCertificateAuthoritiesClient</span></a></em><a class="headerlink" href="#ngrok.Client.ssh_certificate_authorities" title="Permalink to this definition">#</a></dt>
|
||||
@@ -587,6 +600,17 @@ agent tunnel session or an SSH reverse tunnel session.</p>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.Client.vaults">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">vaults</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient" title="ngrok.services.VaultsClient"><span class="pre">VaultsClient</span></a></em><a class="headerlink" href="#ngrok.Client.vaults" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient" title="ngrok.services.VaultsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">VaultsClient</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
@@ -668,6 +692,7 @@ agent tunnel session or an SSH reverse tunnel session.</p>
|
||||
<li><a class="reference internal" href="#ngrok.Client.ip_restrictions"><code class="docutils literal notranslate"><span class="pre">Client.ip_restrictions</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.reserved_addrs"><code class="docutils literal notranslate"><span class="pre">Client.reserved_addrs</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.reserved_domains"><code class="docutils literal notranslate"><span class="pre">Client.reserved_domains</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.secrets"><code class="docutils literal notranslate"><span class="pre">Client.secrets</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.ssh_certificate_authorities"><code class="docutils literal notranslate"><span class="pre">Client.ssh_certificate_authorities</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.ssh_credentials"><code class="docutils literal notranslate"><span class="pre">Client.ssh_credentials</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.ssh_host_certificates"><code class="docutils literal notranslate"><span class="pre">Client.ssh_host_certificates</span></code></a></li>
|
||||
@@ -675,6 +700,7 @@ agent tunnel session or an SSH reverse tunnel session.</p>
|
||||
<li><a class="reference internal" href="#ngrok.Client.tls_certificates"><code class="docutils literal notranslate"><span class="pre">Client.tls_certificates</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.tunnel_sessions"><code class="docutils literal notranslate"><span class="pre">Client.tunnel_sessions</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.tunnels"><code class="docutils literal notranslate"><span class="pre">Client.tunnels</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.Client.vaults"><code class="docutils literal notranslate"><span class="pre">Client.vaults</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -6307,6 +6309,163 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">Secret</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Secret"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Secret" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.created_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#ngrok.datatypes.Secret.created_at" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Timestamp when the Secret was created (RFC 3339 format)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.created_by">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_by</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><span class="pre">Ref</span></a></em><a class="headerlink" href="#ngrok.datatypes.Secret.created_by" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Reference to who created this Secret</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Secret.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Secret.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.description">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Secret.description" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>description of Secret</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.id">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Secret.id" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>identifier for Secret</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.last_updated_by">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">last_updated_by</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><span class="pre">Ref</span></a></em><a class="headerlink" href="#ngrok.datatypes.Secret.last_updated_by" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Reference to who created this Secret</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.metadata">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Secret.metadata" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Arbitrary user-defined metadata for this Secret</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Secret.name" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Name of secret</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.updated_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">updated_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#ngrok.datatypes.Secret.updated_at" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Timestamp when the Secret was last updated (RFC 3339 format)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Secret.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of this Secret API resource</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Secret.vault">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">vault</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><span class="pre">Ref</span></a></em><a class="headerlink" href="#ngrok.datatypes.Secret.vault" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Reference to the vault the secret is stored in</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.SecretList">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">SecretList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SecretList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SecretList" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.SecretList.next_page_uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">next_page_uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.SecretList.next_page_uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the next page of results, or null if there is no next page</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.SecretList.secrets">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">secrets</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ngrok.datatypes.Secret" title="ngrok.datatypes.Secret"><span class="pre">Secret</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.SecretList.secrets" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>The list of Secrets for this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.Secret" title="ngrok.datatypes.Secret"><code class="xref py py-class docutils literal notranslate"><span class="pre">Secret</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.SecretList.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.SecretList.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.StaticBackend">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">StaticBackend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#StaticBackend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.StaticBackend" title="Permalink to this definition">#</a></dt>
|
||||
@@ -7604,6 +7763,157 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">Vault</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Vault"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Vault" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.created_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#ngrok.datatypes.Vault.created_at" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Timestamp when the Vault was created (RFC 3339 format)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.created_by">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_by</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Vault.created_by" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Reference to who created this Vault</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Vault.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Vault.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.description">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Vault.description" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>description of Vault</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.id">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Vault.id" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>identifier for Vault</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.last_updated_by">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">last_updated_by</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Vault.last_updated_by" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Reference to who created this Vault</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.metadata">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Vault.metadata" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Arbitrary user-defined metadata for this Vault</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Vault.name" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Name of vault</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Vault.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Vault.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.updated_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">updated_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#ngrok.datatypes.Vault.updated_at" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Timestamp when the Vault was last updated (RFC 3339 format)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Vault.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Vault.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of this Vault API resource</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.VaultList">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">VaultList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#VaultList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.VaultList" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.VaultList.next_page_uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">next_page_uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.VaultList.next_page_uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the next page of results, or null if there is no next page</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.VaultList.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.VaultList.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.VaultList.vaults">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">vaults</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#ngrok.datatypes.Vault" title="ngrok.datatypes.Vault"><span class="pre">Vault</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.VaultList.vaults" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>The list of Vaults for this account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.Vault" title="ngrok.datatypes.Vault"><code class="xref py py-class docutils literal notranslate"><span class="pre">Vault</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.WeightedBackend">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">WeightedBackend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#WeightedBackend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.WeightedBackend" title="Permalink to this definition">#</a></dt>
|
||||
@@ -8605,6 +8915,26 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.SSHUserCertificateList.uri"><code class="docutils literal notranslate"><span class="pre">SSHUserCertificateList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret"><code class="docutils literal notranslate"><span class="pre">Secret</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.created_at"><code class="docutils literal notranslate"><span class="pre">Secret.created_at</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.created_by"><code class="docutils literal notranslate"><span class="pre">Secret.created_by</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.delete"><code class="docutils literal notranslate"><span class="pre">Secret.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.description"><code class="docutils literal notranslate"><span class="pre">Secret.description</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.id"><code class="docutils literal notranslate"><span class="pre">Secret.id</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.last_updated_by"><code class="docutils literal notranslate"><span class="pre">Secret.last_updated_by</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.metadata"><code class="docutils literal notranslate"><span class="pre">Secret.metadata</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.name"><code class="docutils literal notranslate"><span class="pre">Secret.name</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.updated_at"><code class="docutils literal notranslate"><span class="pre">Secret.updated_at</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.uri"><code class="docutils literal notranslate"><span class="pre">Secret.uri</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Secret.vault"><code class="docutils literal notranslate"><span class="pre">Secret.vault</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.SecretList"><code class="docutils literal notranslate"><span class="pre">SecretList</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.SecretList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">SecretList.next_page_uri</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.SecretList.secrets"><code class="docutils literal notranslate"><span class="pre">SecretList.secrets</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.SecretList.uri"><code class="docutils literal notranslate"><span class="pre">SecretList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend"><code class="docutils literal notranslate"><span class="pre">StaticBackend</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.address"><code class="docutils literal notranslate"><span class="pre">StaticBackend.address</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.StaticBackend.created_at"><code class="docutils literal notranslate"><span class="pre">StaticBackend.created_at</span></code></a></li>
|
||||
@@ -8772,6 +9102,26 @@
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.UserAgent.raw"><code class="docutils literal notranslate"><span class="pre">UserAgent.raw</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault"><code class="docutils literal notranslate"><span class="pre">Vault</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.created_at"><code class="docutils literal notranslate"><span class="pre">Vault.created_at</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.created_by"><code class="docutils literal notranslate"><span class="pre">Vault.created_by</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.delete"><code class="docutils literal notranslate"><span class="pre">Vault.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.description"><code class="docutils literal notranslate"><span class="pre">Vault.description</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.id"><code class="docutils literal notranslate"><span class="pre">Vault.id</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.last_updated_by"><code class="docutils literal notranslate"><span class="pre">Vault.last_updated_by</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.metadata"><code class="docutils literal notranslate"><span class="pre">Vault.metadata</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.name"><code class="docutils literal notranslate"><span class="pre">Vault.name</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.update"><code class="docutils literal notranslate"><span class="pre">Vault.update()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.updated_at"><code class="docutils literal notranslate"><span class="pre">Vault.updated_at</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.Vault.uri"><code class="docutils literal notranslate"><span class="pre">Vault.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.VaultList"><code class="docutils literal notranslate"><span class="pre">VaultList</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.VaultList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">VaultList.next_page_uri</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.VaultList.uri"><code class="docutils literal notranslate"><span class="pre">VaultList.uri</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.VaultList.vaults"><code class="docutils literal notranslate"><span class="pre">VaultList.vaults</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.WeightedBackend"><code class="docutils literal notranslate"><span class="pre">WeightedBackend</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.WeightedBackend.backends"><code class="docutils literal notranslate"><span class="pre">WeightedBackend.backends</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.datatypes.WeightedBackend.created_at"><code class="docutils literal notranslate"><span class="pre">WeightedBackend.created_at</span></code></a></li>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
+111
-7
@@ -210,12 +210,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -612,6 +614,8 @@
|
||||
<li><a href="reserved_addrs.html#ngrok.services.ReservedAddrsClient.create">(ngrok.services.ReservedAddrsClient method)</a>
|
||||
</li>
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.create">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.create">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.create">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -626,6 +630,8 @@
|
||||
<li><a href="tls_certificates.html#ngrok.services.TLSCertificatesClient.create">(ngrok.services.TLSCertificatesClient method)</a>
|
||||
</li>
|
||||
<li><a href="tunnel_group_backends.html#ngrok.services.TunnelGroupBackendsClient.create">(ngrok.services.TunnelGroupBackendsClient method)</a>
|
||||
</li>
|
||||
<li><a href="vaults.html#ngrok.services.VaultsClient.create">(ngrok.services.VaultsClient method)</a>
|
||||
</li>
|
||||
<li><a href="weighted_backends.html#ngrok.services.WeightedBackendsClient.create">(ngrok.services.WeightedBackendsClient method)</a>
|
||||
</li>
|
||||
@@ -672,6 +678,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedAddr.created_at">(ngrok.datatypes.ReservedAddr property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.created_at">(ngrok.datatypes.ReservedDomain property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.created_at">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.created_at">(ngrok.datatypes.SSHCertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -690,8 +698,16 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TLSEdge.created_at">(ngrok.datatypes.TLSEdge property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelGroupBackend.created_at">(ngrok.datatypes.TunnelGroupBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.created_at">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackend.created_at">(ngrok.datatypes.WeightedBackend property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.created_by">created_by (ngrok.datatypes.Secret property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.created_by">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Credential">Credential (class in ngrok.datatypes)</a>
|
||||
@@ -768,6 +784,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedAddr.delete">(ngrok.datatypes.ReservedAddr method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.delete">(ngrok.datatypes.ReservedDomain method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.delete">(ngrok.datatypes.Secret method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.delete">(ngrok.datatypes.SSHCertificateAuthority method)</a>
|
||||
</li>
|
||||
@@ -786,6 +804,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TLSEdge.delete">(ngrok.datatypes.TLSEdge method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelGroupBackend.delete">(ngrok.datatypes.TunnelGroupBackend method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.delete">(ngrok.datatypes.Vault method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackend.delete">(ngrok.datatypes.WeightedBackend method)</a>
|
||||
</li>
|
||||
@@ -862,6 +882,8 @@
|
||||
<li><a href="reserved_addrs.html#ngrok.services.ReservedAddrsClient.delete">(ngrok.services.ReservedAddrsClient method)</a>
|
||||
</li>
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.delete">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.delete">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.delete">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -892,6 +914,8 @@
|
||||
<li><a href="tls_edge_traffic_policy_module.html#ngrok.services.TLSEdgeTrafficPolicyModuleClient.delete">(ngrok.services.TLSEdgeTrafficPolicyModuleClient method)</a>
|
||||
</li>
|
||||
<li><a href="tunnel_group_backends.html#ngrok.services.TunnelGroupBackendsClient.delete">(ngrok.services.TunnelGroupBackendsClient method)</a>
|
||||
</li>
|
||||
<li><a href="vaults.html#ngrok.services.VaultsClient.delete">(ngrok.services.VaultsClient method)</a>
|
||||
</li>
|
||||
<li><a href="weighted_backends.html#ngrok.services.WeightedBackendsClient.delete">(ngrok.services.WeightedBackendsClient method)</a>
|
||||
</li>
|
||||
@@ -938,6 +962,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedAddr.description">(ngrok.datatypes.ReservedAddr property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.description">(ngrok.datatypes.ReservedDomain property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.description">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.description">(ngrok.datatypes.SSHCertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -956,6 +982,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TLSEdge.description">(ngrok.datatypes.TLSEdge property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelGroupBackend.description">(ngrok.datatypes.TunnelGroupBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.description">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackend.description">(ngrok.datatypes.WeightedBackend property)</a>
|
||||
</li>
|
||||
@@ -1372,6 +1400,8 @@
|
||||
<li><a href="reserved_addrs.html#ngrok.services.ReservedAddrsClient.get">(ngrok.services.ReservedAddrsClient method)</a>
|
||||
</li>
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.get">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.get">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.get">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -1406,6 +1436,8 @@
|
||||
<li><a href="tunnels.html#ngrok.services.TunnelsClient.get">(ngrok.services.TunnelsClient method)</a>
|
||||
</li>
|
||||
<li><a href="tunnel_sessions.html#ngrok.services.TunnelSessionsClient.get">(ngrok.services.TunnelSessionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="vaults.html#ngrok.services.VaultsClient.get">(ngrok.services.VaultsClient method)</a>
|
||||
</li>
|
||||
<li><a href="weighted_backends.html#ngrok.services.WeightedBackendsClient.get">(ngrok.services.WeightedBackendsClient method)</a>
|
||||
</li>
|
||||
@@ -1514,6 +1546,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedAddr.id">(ngrok.datatypes.ReservedAddr property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.id">(ngrok.datatypes.ReservedDomain property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.id">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.id">(ngrok.datatypes.SSHCertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -1536,16 +1570,18 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelGroupBackend.id">(ngrok.datatypes.TunnelGroupBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSession.id">(ngrok.datatypes.TunnelSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.id">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackend.id">(ngrok.datatypes.WeightedBackend property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.identity_provider">identity_provider (ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider">IdentityProvider (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider">IdentityProvider (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.idp_metadata">idp_metadata (ngrok.datatypes.EndpointSAML property)</a>
|
||||
|
||||
<ul>
|
||||
@@ -1678,6 +1714,12 @@
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.last_login">last_login (ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.last_updated_by">last_updated_by (ngrok.datatypes.Secret property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.last_updated_by">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Location.lat_long_radius_km">lat_long_radius_km (ngrok.datatypes.Location property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Location.latitude">latitude (ngrok.datatypes.Location property)</a>
|
||||
@@ -1726,6 +1768,8 @@
|
||||
<li><a href="reserved_addrs.html#ngrok.services.ReservedAddrsClient.list">(ngrok.services.ReservedAddrsClient method)</a>
|
||||
</li>
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.list">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.list">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.list">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -1744,6 +1788,8 @@
|
||||
<li><a href="tunnels.html#ngrok.services.TunnelsClient.list">(ngrok.services.TunnelsClient method)</a>
|
||||
</li>
|
||||
<li><a href="tunnel_sessions.html#ngrok.services.TunnelSessionsClient.list">(ngrok.services.TunnelSessionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="vaults.html#ngrok.services.VaultsClient.list">(ngrok.services.VaultsClient method)</a>
|
||||
</li>
|
||||
<li><a href="weighted_backends.html#ngrok.services.WeightedBackendsClient.list">(ngrok.services.WeightedBackendsClient method)</a>
|
||||
</li>
|
||||
@@ -1816,6 +1862,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedAddr.metadata">(ngrok.datatypes.ReservedAddr property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.metadata">(ngrok.datatypes.ReservedDomain property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.metadata">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.metadata">(ngrok.datatypes.SSHCertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -1838,6 +1886,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelGroupBackend.metadata">(ngrok.datatypes.TunnelGroupBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSession.metadata">(ngrok.datatypes.TunnelSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.metadata">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackend.metadata">(ngrok.datatypes.WeightedBackend property)</a>
|
||||
</li>
|
||||
@@ -1862,7 +1912,7 @@
|
||||
</li>
|
||||
<li><a href="datatypes.html#module-ngrok.datatypes">ngrok.datatypes</a>
|
||||
</li>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">ngrok.services</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_traffic_policy_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[20]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[21]</a>, <a href="edges_https.html#module-ngrok.services">[22]</a>, <a href="edges_https_routes.html#module-ngrok.services">[23]</a>, <a href="edges_tcp.html#module-ngrok.services">[24]</a>, <a href="edges_tls.html#module-ngrok.services">[25]</a>, <a href="endpoints.html#module-ngrok.services">[26]</a>, <a href="event_destinations.html#module-ngrok.services">[27]</a>, <a href="event_sources.html#module-ngrok.services">[28]</a>, <a href="event_subscriptions.html#module-ngrok.services">[29]</a>, <a href="failover_backends.html#module-ngrok.services">[30]</a>, <a href="http_response_backends.html#module-ngrok.services">[31]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[32]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[33]</a>, <a href="ip_policies.html#module-ngrok.services">[34]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[35]</a>, <a href="ip_restrictions.html#module-ngrok.services">[36]</a>, <a href="reserved_addrs.html#module-ngrok.services">[37]</a>, <a href="reserved_domains.html#module-ngrok.services">[38]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[39]</a>, <a href="ssh_credentials.html#module-ngrok.services">[40]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[41]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[42]</a>, <a href="static_backends.html#module-ngrok.services">[43]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[44]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[45]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[46]</a>, <a href="tcp_edge_traffic_policy_module.html#module-ngrok.services">[47]</a>, <a href="tls_certificates.html#module-ngrok.services">[48]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[49]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[50]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[51]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[52]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[53]</a>, <a href="tls_edge_traffic_policy_module.html#module-ngrok.services">[54]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[55]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[56]</a>, <a href="tunnels.html#module-ngrok.services">[57]</a>, <a href="weighted_backends.html#module-ngrok.services">[58]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">ngrok.services</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_traffic_policy_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[20]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[21]</a>, <a href="edges_https.html#module-ngrok.services">[22]</a>, <a href="edges_https_routes.html#module-ngrok.services">[23]</a>, <a href="edges_tcp.html#module-ngrok.services">[24]</a>, <a href="edges_tls.html#module-ngrok.services">[25]</a>, <a href="endpoints.html#module-ngrok.services">[26]</a>, <a href="event_destinations.html#module-ngrok.services">[27]</a>, <a href="event_sources.html#module-ngrok.services">[28]</a>, <a href="event_subscriptions.html#module-ngrok.services">[29]</a>, <a href="failover_backends.html#module-ngrok.services">[30]</a>, <a href="http_response_backends.html#module-ngrok.services">[31]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[32]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[33]</a>, <a href="ip_policies.html#module-ngrok.services">[34]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[35]</a>, <a href="ip_restrictions.html#module-ngrok.services">[36]</a>, <a href="reserved_addrs.html#module-ngrok.services">[37]</a>, <a href="reserved_domains.html#module-ngrok.services">[38]</a>, <a href="secrets.html#module-ngrok.services">[39]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[40]</a>, <a href="ssh_credentials.html#module-ngrok.services">[41]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[42]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[43]</a>, <a href="static_backends.html#module-ngrok.services">[44]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[45]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[46]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[47]</a>, <a href="tcp_edge_traffic_policy_module.html#module-ngrok.services">[48]</a>, <a href="tls_certificates.html#module-ngrok.services">[49]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[50]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[51]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[52]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[53]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[54]</a>, <a href="tls_edge_traffic_policy_module.html#module-ngrok.services">[55]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[56]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[57]</a>, <a href="tunnels.html#module-ngrok.services">[58]</a>, <a href="vaults.html#module-ngrok.services">[59]</a>, <a href="weighted_backends.html#module-ngrok.services">[60]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AgentIngressCertJob.msg">msg (ngrok.datatypes.AgentIngressCertJob property)</a>
|
||||
@@ -1893,6 +1943,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.name">(ngrok.datatypes.Endpoint property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider.name">(ngrok.datatypes.IdentityProvider property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.name">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.name">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.nameid_format">nameid_format (ngrok.datatypes.EndpointSAML property)</a>
|
||||
@@ -1937,6 +1991,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedAddrList.next_page_uri">(ngrok.datatypes.ReservedAddrList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomainList.next_page_uri">(ngrok.datatypes.ReservedDomainList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SecretList.next_page_uri">(ngrok.datatypes.SecretList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthorityList.next_page_uri">(ngrok.datatypes.SSHCertificateAuthorityList property)</a>
|
||||
</li>
|
||||
@@ -1959,6 +2015,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelList.next_page_uri">(ngrok.datatypes.TunnelList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSessionList.next_page_uri">(ngrok.datatypes.TunnelSessionList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.VaultList.next_page_uri">(ngrok.datatypes.VaultList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackendList.next_page_uri">(ngrok.datatypes.WeightedBackendList property)</a>
|
||||
</li>
|
||||
@@ -1983,7 +2041,7 @@
|
||||
ngrok.services
|
||||
|
||||
<ul>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_traffic_policy_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[20]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[21]</a>, <a href="edges_https.html#module-ngrok.services">[22]</a>, <a href="edges_https_routes.html#module-ngrok.services">[23]</a>, <a href="edges_tcp.html#module-ngrok.services">[24]</a>, <a href="edges_tls.html#module-ngrok.services">[25]</a>, <a href="endpoints.html#module-ngrok.services">[26]</a>, <a href="event_destinations.html#module-ngrok.services">[27]</a>, <a href="event_sources.html#module-ngrok.services">[28]</a>, <a href="event_subscriptions.html#module-ngrok.services">[29]</a>, <a href="failover_backends.html#module-ngrok.services">[30]</a>, <a href="http_response_backends.html#module-ngrok.services">[31]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[32]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[33]</a>, <a href="ip_policies.html#module-ngrok.services">[34]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[35]</a>, <a href="ip_restrictions.html#module-ngrok.services">[36]</a>, <a href="reserved_addrs.html#module-ngrok.services">[37]</a>, <a href="reserved_domains.html#module-ngrok.services">[38]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[39]</a>, <a href="ssh_credentials.html#module-ngrok.services">[40]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[41]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[42]</a>, <a href="static_backends.html#module-ngrok.services">[43]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[44]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[45]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[46]</a>, <a href="tcp_edge_traffic_policy_module.html#module-ngrok.services">[47]</a>, <a href="tls_certificates.html#module-ngrok.services">[48]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[49]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[50]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[51]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[52]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[53]</a>, <a href="tls_edge_traffic_policy_module.html#module-ngrok.services">[54]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[55]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[56]</a>, <a href="tunnels.html#module-ngrok.services">[57]</a>, <a href="weighted_backends.html#module-ngrok.services">[58]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="bot_users.html#module-ngrok.services">[5]</a>, <a href="certificate_authorities.html#module-ngrok.services">[6]</a>, <a href="credentials.html#module-ngrok.services">[7]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_policy_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[17]</a>, <a href="edge_route_traffic_policy_module.html#module-ngrok.services">[18]</a>, <a href="edge_route_user_agent_filter_module.html#module-ngrok.services">[19]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[20]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[21]</a>, <a href="edges_https.html#module-ngrok.services">[22]</a>, <a href="edges_https_routes.html#module-ngrok.services">[23]</a>, <a href="edges_tcp.html#module-ngrok.services">[24]</a>, <a href="edges_tls.html#module-ngrok.services">[25]</a>, <a href="endpoints.html#module-ngrok.services">[26]</a>, <a href="event_destinations.html#module-ngrok.services">[27]</a>, <a href="event_sources.html#module-ngrok.services">[28]</a>, <a href="event_subscriptions.html#module-ngrok.services">[29]</a>, <a href="failover_backends.html#module-ngrok.services">[30]</a>, <a href="http_response_backends.html#module-ngrok.services">[31]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[32]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[33]</a>, <a href="ip_policies.html#module-ngrok.services">[34]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[35]</a>, <a href="ip_restrictions.html#module-ngrok.services">[36]</a>, <a href="reserved_addrs.html#module-ngrok.services">[37]</a>, <a href="reserved_domains.html#module-ngrok.services">[38]</a>, <a href="secrets.html#module-ngrok.services">[39]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[40]</a>, <a href="ssh_credentials.html#module-ngrok.services">[41]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[42]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[43]</a>, <a href="static_backends.html#module-ngrok.services">[44]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[45]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[46]</a>, <a href="tcp_edge_policy_module.html#module-ngrok.services">[47]</a>, <a href="tcp_edge_traffic_policy_module.html#module-ngrok.services">[48]</a>, <a href="tls_certificates.html#module-ngrok.services">[49]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[50]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[51]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[52]</a>, <a href="tls_edge_policy_module.html#module-ngrok.services">[53]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[54]</a>, <a href="tls_edge_traffic_policy_module.html#module-ngrok.services">[55]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[56]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[57]</a>, <a href="tunnels.html#module-ngrok.services">[58]</a>, <a href="vaults.html#module-ngrok.services">[59]</a>, <a href="weighted_backends.html#module-ngrok.services">[60]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.not_after">not_after (ngrok.datatypes.CertificateAuthority property)</a>
|
||||
@@ -2288,7 +2346,19 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOIDC.scopes">(ngrok.datatypes.EndpointOIDC property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret">Secret (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointWebhookValidation.secret">secret (ngrok.datatypes.EndpointWebhookValidation property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SecretList">SecretList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.secrets">secrets (ngrok.Client property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SecretList.secrets">(ngrok.datatypes.SecretList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient">SecretsClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TLSCertificate.serial_number">serial_number (ngrok.datatypes.TLSCertificate property)</a>
|
||||
</li>
|
||||
@@ -2332,14 +2402,14 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificateList.ssh_user_certificates">(ngrok.datatypes.SSHUserCertificateList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient">SSHCertificateAuthoritiesClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority">SSHCertificateAuthority (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthorityList">SSHCertificateAuthorityList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCredential">SSHCredential (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCredentialList">SSHCredentialList (class in ngrok.datatypes)</a>
|
||||
@@ -2598,6 +2668,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TLSEdge.update">(ngrok.datatypes.TLSEdge method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelGroupBackend.update">(ngrok.datatypes.TunnelGroupBackend method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.update">(ngrok.datatypes.Vault method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackend.update">(ngrok.datatypes.WeightedBackend method)</a>
|
||||
</li>
|
||||
@@ -2640,6 +2712,8 @@
|
||||
<li><a href="reserved_addrs.html#ngrok.services.ReservedAddrsClient.update">(ngrok.services.ReservedAddrsClient method)</a>
|
||||
</li>
|
||||
<li><a href="reserved_domains.html#ngrok.services.ReservedDomainsClient.update">(ngrok.services.ReservedDomainsClient method)</a>
|
||||
</li>
|
||||
<li><a href="secrets.html#ngrok.services.SecretsClient.update">(ngrok.services.SecretsClient method)</a>
|
||||
</li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.update">(ngrok.services.SSHCertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -2656,12 +2730,20 @@
|
||||
<li><a href="tunnel_group_backends.html#ngrok.services.TunnelGroupBackendsClient.update">(ngrok.services.TunnelGroupBackendsClient method)</a>
|
||||
</li>
|
||||
<li><a href="tunnel_sessions.html#ngrok.services.TunnelSessionsClient.update">(ngrok.services.TunnelSessionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="vaults.html#ngrok.services.VaultsClient.update">(ngrok.services.VaultsClient method)</a>
|
||||
</li>
|
||||
<li><a href="weighted_backends.html#ngrok.services.WeightedBackendsClient.update">(ngrok.services.WeightedBackendsClient method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.updated_at">updated_at (ngrok.datatypes.Endpoint property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.updated_at">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.updated_at">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.upstream_protocol">upstream_protocol (ngrok.datatypes.Endpoint property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.upstream_url">upstream_url (ngrok.datatypes.Endpoint property)</a>
|
||||
@@ -2748,6 +2830,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomain.uri">(ngrok.datatypes.ReservedDomain property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomainList.uri">(ngrok.datatypes.ReservedDomainList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.uri">(ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SecretList.uri">(ngrok.datatypes.SecretList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.uri">(ngrok.datatypes.SSHCertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -2790,6 +2876,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSession.uri">(ngrok.datatypes.TunnelSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSessionList.uri">(ngrok.datatypes.TunnelSessionList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault.uri">(ngrok.datatypes.Vault property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.VaultList.uri">(ngrok.datatypes.VaultList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackend.uri">(ngrok.datatypes.WeightedBackend property)</a>
|
||||
</li>
|
||||
@@ -2834,9 +2924,23 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificate.valid_until">(ngrok.datatypes.SSHUserCertificate property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointTrafficPolicy.value">value (ngrok.datatypes.EndpointTrafficPolicy property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Vault">Vault (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointTrafficPolicy.value">value (ngrok.datatypes.EndpointTrafficPolicy property)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Secret.vault">vault (ngrok.datatypes.Secret property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.VaultList">VaultList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.vaults">vaults (ngrok.Client property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.VaultList.vaults">(ngrok.datatypes.VaultList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="vaults.html#ngrok.services.VaultsClient">VaultsClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker.volume_threshold">volume_threshold (ngrok.datatypes.EndpointCircuitBreaker property)</a>
|
||||
</li>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -374,6 +376,7 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.ip_restrictions"><code class="docutils literal notranslate"><span class="pre">Client.ip_restrictions</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.reserved_addrs"><code class="docutils literal notranslate"><span class="pre">Client.reserved_addrs</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.reserved_domains"><code class="docutils literal notranslate"><span class="pre">Client.reserved_domains</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.secrets"><code class="docutils literal notranslate"><span class="pre">Client.secrets</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.ssh_certificate_authorities"><code class="docutils literal notranslate"><span class="pre">Client.ssh_certificate_authorities</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.ssh_credentials"><code class="docutils literal notranslate"><span class="pre">Client.ssh_credentials</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.ssh_host_certificates"><code class="docutils literal notranslate"><span class="pre">Client.ssh_host_certificates</span></code></a></li>
|
||||
@@ -381,6 +384,7 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.tls_certificates"><code class="docutils literal notranslate"><span class="pre">Client.tls_certificates</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.tunnel_sessions"><code class="docutils literal notranslate"><span class="pre">Client.tunnel_sessions</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.tunnels"><code class="docutils literal notranslate"><span class="pre">Client.tunnels</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="client.html#ngrok.Client.vaults"><code class="docutils literal notranslate"><span class="pre">Client.vaults</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -1210,6 +1214,26 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHUserCertificateList.uri"><code class="docutils literal notranslate"><span class="pre">SSHUserCertificateList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret"><code class="docutils literal notranslate"><span class="pre">Secret</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.created_at"><code class="docutils literal notranslate"><span class="pre">Secret.created_at</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.created_by"><code class="docutils literal notranslate"><span class="pre">Secret.created_by</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.delete"><code class="docutils literal notranslate"><span class="pre">Secret.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.description"><code class="docutils literal notranslate"><span class="pre">Secret.description</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.id"><code class="docutils literal notranslate"><span class="pre">Secret.id</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.last_updated_by"><code class="docutils literal notranslate"><span class="pre">Secret.last_updated_by</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.metadata"><code class="docutils literal notranslate"><span class="pre">Secret.metadata</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.name"><code class="docutils literal notranslate"><span class="pre">Secret.name</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.updated_at"><code class="docutils literal notranslate"><span class="pre">Secret.updated_at</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.uri"><code class="docutils literal notranslate"><span class="pre">Secret.uri</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret.vault"><code class="docutils literal notranslate"><span class="pre">Secret.vault</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.SecretList"><code class="docutils literal notranslate"><span class="pre">SecretList</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.SecretList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">SecretList.next_page_uri</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.SecretList.secrets"><code class="docutils literal notranslate"><span class="pre">SecretList.secrets</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.SecretList.uri"><code class="docutils literal notranslate"><span class="pre">SecretList.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend"><code class="docutils literal notranslate"><span class="pre">StaticBackend</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.address"><code class="docutils literal notranslate"><span class="pre">StaticBackend.address</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.StaticBackend.created_at"><code class="docutils literal notranslate"><span class="pre">StaticBackend.created_at</span></code></a></li>
|
||||
@@ -1377,6 +1401,26 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.UserAgent.raw"><code class="docutils literal notranslate"><span class="pre">UserAgent.raw</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault"><code class="docutils literal notranslate"><span class="pre">Vault</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.created_at"><code class="docutils literal notranslate"><span class="pre">Vault.created_at</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.created_by"><code class="docutils literal notranslate"><span class="pre">Vault.created_by</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.delete"><code class="docutils literal notranslate"><span class="pre">Vault.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.description"><code class="docutils literal notranslate"><span class="pre">Vault.description</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.id"><code class="docutils literal notranslate"><span class="pre">Vault.id</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.last_updated_by"><code class="docutils literal notranslate"><span class="pre">Vault.last_updated_by</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.metadata"><code class="docutils literal notranslate"><span class="pre">Vault.metadata</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.name"><code class="docutils literal notranslate"><span class="pre">Vault.name</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.update"><code class="docutils literal notranslate"><span class="pre">Vault.update()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.updated_at"><code class="docutils literal notranslate"><span class="pre">Vault.updated_at</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault.uri"><code class="docutils literal notranslate"><span class="pre">Vault.uri</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.VaultList"><code class="docutils literal notranslate"><span class="pre">VaultList</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.VaultList.next_page_uri"><code class="docutils literal notranslate"><span class="pre">VaultList.next_page_uri</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.VaultList.uri"><code class="docutils literal notranslate"><span class="pre">VaultList.uri</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.VaultList.vaults"><code class="docutils literal notranslate"><span class="pre">VaultList.vaults</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.WeightedBackend"><code class="docutils literal notranslate"><span class="pre">WeightedBackend</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.WeightedBackend.backends"><code class="docutils literal notranslate"><span class="pre">WeightedBackend.backends</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.WeightedBackend.created_at"><code class="docutils literal notranslate"><span class="pre">WeightedBackend.created_at</span></code></a></li>
|
||||
@@ -1911,6 +1955,17 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient"><code class="docutils literal notranslate"><span class="pre">SecretsClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient.create"><code class="docutils literal notranslate"><span class="pre">SecretsClient.create()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient.delete"><code class="docutils literal notranslate"><span class="pre">SecretsClient.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient.get"><code class="docutils literal notranslate"><span class="pre">SecretsClient.get()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient.list"><code class="docutils literal notranslate"><span class="pre">SecretsClient.list()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient.update"><code class="docutils literal notranslate"><span class="pre">SecretsClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient"><code class="docutils literal notranslate"><span class="pre">SSHCertificateAuthoritiesClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.create"><code class="docutils literal notranslate"><span class="pre">SSHCertificateAuthoritiesClient.create()</span></code></a></li>
|
||||
@@ -1974,6 +2029,17 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient"><code class="docutils literal notranslate"><span class="pre">VaultsClient</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient.create"><code class="docutils literal notranslate"><span class="pre">VaultsClient.create()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient.delete"><code class="docutils literal notranslate"><span class="pre">VaultsClient.delete()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient.get"><code class="docutils literal notranslate"><span class="pre">VaultsClient.get()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient.list"><code class="docutils literal notranslate"><span class="pre">VaultsClient.list()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient.update"><code class="docutils literal notranslate"><span class="pre">VaultsClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
Binary file not shown.
@@ -210,12 +210,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH Certificate Authorities" href="ssh_certificate_authorities.html" /><link rel="prev" title="Reserved Addresses" href="reserved_addrs.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Secrets" href="secrets.html" /><link rel="prev" title="Reserved Addresses" href="reserved_addrs.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Reserved Domains - ngrok-api documentation</title>
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -392,12 +394,12 @@ This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="ssh_certificate_authorities.html">
|
||||
<a class="next-page" href="secrets.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">SSH Certificate Authorities</div>
|
||||
<div class="title">Secrets</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@@ -209,12 +209,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -0,0 +1,444 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH Certificate Authorities" href="ssh_certificate_authorities.html" /><link rel="prev" title="Reserved Domains" href="reserved_domains.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Secrets - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="static_backends.html">Static Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bot_users.html">Bot Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_traffic_policy_module.html">HTTPS Edge Route Traffic Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_traffic_policy_module.html">TCP Edge Traffic Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_traffic_policy_module.html">TLS Edge Traffic Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="secrets">
|
||||
<h1>Secrets<a class="headerlink" href="#secrets" title="Permalink to this heading">#</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<a class="reference internal" href="client.html#ngrok.Client.secrets" title="ngrok.Client.secrets"><code class="xref py py-attr docutils literal notranslate"><span class="pre">secrets</span></code></a> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SecretsClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">SecretsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SecretsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SecretsClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vault_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SecretsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create a new Secret</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of secret</p></li>
|
||||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Value of secret</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 metadata for this Secret</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – description of Secret</p></li>
|
||||
<li><p><strong>vault_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique identifier of the referenced vault</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-secrets-create">https://ngrok.com/docs/api#api-secrets-create</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret" title="ngrok.datatypes.Secret"><code class="xref py py-class docutils literal notranslate"><span class="pre">Secret</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SecretsClient.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SecretsClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Delete a Secret</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-secrets-delete">https://ngrok.com/docs/api#api-secrets-delete</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SecretsClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SecretsClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Get a Secret by ID</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-secrets-get">https://ngrok.com/docs/api#api-secrets-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret" title="ngrok.datatypes.Secret"><code class="xref py py-class docutils literal notranslate"><span class="pre">Secret</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SecretsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SecretsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all Secrets owned by account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-secrets-list">https://ngrok.com/docs/api#api-secrets-list</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SecretList" title="ngrok.datatypes.SecretList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SecretList</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.SecretsClient.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SecretsClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SecretsClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Update an existing Secret by ID</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier for Secret</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of secret</p></li>
|
||||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Value of secret</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 metadata for this Secret</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – description of Secret</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-secrets-update">https://ngrok.com/docs/api#api-secrets-update</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Secret" title="ngrok.datatypes.Secret"><code class="xref py py-class docutils literal notranslate"><span class="pre">Secret</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="ssh_certificate_authorities.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">SSH Certificate Authorities</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="reserved_domains.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Reserved Domains</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Secrets</a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.SecretsClient"><code class="docutils literal notranslate"><span class="pre">SecretsClient</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.SecretsClient.create"><code class="docutils literal notranslate"><span class="pre">SecretsClient.create()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.SecretsClient.delete"><code class="docutils literal notranslate"><span class="pre">SecretsClient.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.SecretsClient.get"><code class="docutils literal notranslate"><span class="pre">SecretsClient.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.SecretsClient.list"><code class="docutils literal notranslate"><span class="pre">SecretsClient.list()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.SecretsClient.update"><code class="docutils literal notranslate"><span class="pre">SecretsClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/scripts/furo.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH Credentials" href="ssh_credentials.html" /><link rel="prev" title="Reserved Domains" href="reserved_domains.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SSH Credentials" href="ssh_credentials.html" /><link rel="prev" title="Secrets" href="secrets.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>SSH Certificate Authorities - ngrok-api documentation</title>
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -372,14 +374,14 @@ key that can be used to sign other SSH host and user certificates.</p>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="reserved_domains.html">
|
||||
<a class="prev-page" href="secrets.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Reserved Domains</div>
|
||||
<div class="title">Secrets</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
+12
-2
@@ -3,7 +3,7 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="TLS Certificates" href="tls_certificates.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Vaults" href="vaults.html" /><link rel="prev" title="TLS Certificates" href="tls_certificates.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Tunnels - ngrok-api documentation</title>
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@@ -307,7 +309,15 @@ agent tunnel session or an SSH reverse tunnel session.</p>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
|
||||
<a class="next-page" href="vaults.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Vaults</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="tls_certificates.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
|
||||
@@ -0,0 +1,433 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Tunnels" href="tunnels.html" />
|
||||
|
||||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||||
<title>Vaults - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="static_backends.html">Static Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bot_users.html">Bot Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_traffic_policy_module.html">HTTPS Edge Route Traffic Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_traffic_policy_module.html">TCP Edge Traffic Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_traffic_policy_module.html">TLS Edge Traffic Policy Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="vaults">
|
||||
<h1>Vaults<a class="headerlink" href="#vaults" title="Permalink to this heading">#</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<a class="reference internal" href="client.html#ngrok.Client.vaults" title="ngrok.Client.vaults"><code class="xref py py-attr docutils literal notranslate"><span class="pre">vaults</span></code></a> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt class="sig sig-object py" id="ngrok.services.VaultsClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.services.</span></span><span class="sig-name descname"><span class="pre">VaultsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#VaultsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.VaultsClient" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.VaultsClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#VaultsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.VaultsClient.create" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create a new Vault</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of vault</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 metadata for this Vault</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – description of Vault</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-vaults-create">https://ngrok.com/docs/api#api-vaults-create</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault" title="ngrok.datatypes.Vault"><code class="xref py py-class docutils literal notranslate"><span class="pre">Vault</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.VaultsClient.delete">
|
||||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#VaultsClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.VaultsClient.delete" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Delete a Vault</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-vaults-delete">https://ngrok.com/docs/api#api-vaults-delete</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.VaultsClient.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#VaultsClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.VaultsClient.get" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Get a Vault by ID</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-vaults-get">https://ngrok.com/docs/api#api-vaults-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault" title="ngrok.datatypes.Vault"><code class="xref py py-class docutils literal notranslate"><span class="pre">Vault</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.VaultsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#VaultsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.VaultsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all Vaults owned by account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-vaults-list">https://ngrok.com/docs/api#api-vaults-list</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.VaultList" title="ngrok.datatypes.VaultList"><code class="xref py py-class docutils literal notranslate"><span class="pre">VaultList</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.VaultsClient.update">
|
||||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#VaultsClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.VaultsClient.update" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Update an existing Vault by ID</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier for Vault</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of vault</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 metadata for this Vault</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – description of Vault</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-vaults-update">https://ngrok.com/docs/api#api-vaults-update</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Vault" title="ngrok.datatypes.Vault"><code class="xref py py-class docutils literal notranslate"><span class="pre">Vault</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
|
||||
<a class="prev-page" href="tunnels.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Tunnels</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Vaults</a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.VaultsClient"><code class="docutils literal notranslate"><span class="pre">VaultsClient</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#ngrok.services.VaultsClient.create"><code class="docutils literal notranslate"><span class="pre">VaultsClient.create()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.VaultsClient.delete"><code class="docutils literal notranslate"><span class="pre">VaultsClient.delete()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.VaultsClient.get"><code class="docutils literal notranslate"><span class="pre">VaultsClient.get()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.VaultsClient.list"><code class="docutils literal notranslate"><span class="pre">VaultsClient.list()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#ngrok.services.VaultsClient.update"><code class="docutils literal notranslate"><span class="pre">VaultsClient.update()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/scripts/furo.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -212,12 +212,14 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -124,6 +124,11 @@ class Client(object):
|
||||
This CNAME record points traffic for that domain to ngrok's edge servers."""
|
||||
return ReservedDomainsClient(self)
|
||||
|
||||
@property
|
||||
def secrets(self) -> SecretsClient:
|
||||
"""Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""
|
||||
return SecretsClient(self)
|
||||
|
||||
@property
|
||||
def ssh_certificate_authorities(self) -> SSHCertificateAuthoritiesClient:
|
||||
"""An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
||||
@@ -165,6 +170,11 @@ class Client(object):
|
||||
agent tunnel session or an SSH reverse tunnel session."""
|
||||
return TunnelsClient(self)
|
||||
|
||||
@property
|
||||
def vaults(self) -> VaultsClient:
|
||||
"""Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""
|
||||
return VaultsClient(self)
|
||||
|
||||
@property
|
||||
def backends(self):
|
||||
ns = collections.namedtuple(
|
||||
|
||||
@@ -5105,6 +5105,128 @@ class ReservedDomainCertJob(object):
|
||||
return self._props["retries_at"]
|
||||
|
||||
|
||||
class Secret(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["created_by"] = (
|
||||
Ref(client, props["created_by"])
|
||||
if props.get("created_by") is not None
|
||||
else None
|
||||
)
|
||||
self._props["last_updated_by"] = (
|
||||
Ref(client, props["last_updated_by"])
|
||||
if props.get("last_updated_by") is not None
|
||||
else None
|
||||
)
|
||||
self._props["vault"] = (
|
||||
Ref(client, props["vault"]) if props.get("vault") is not None else None
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<Secret {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<Secret {}>".format(repr(self._props))
|
||||
|
||||
def delete(
|
||||
self,
|
||||
):
|
||||
self._client.secrets.delete(
|
||||
id=self.id,
|
||||
)
|
||||
|
||||
@property
|
||||
def id(self) -> str:
|
||||
"""identifier for Secret"""
|
||||
return self._props["id"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of this Secret API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def created_at(self) -> datetime:
|
||||
"""Timestamp when the Secret was created (RFC 3339 format)"""
|
||||
return self._props["created_at"]
|
||||
|
||||
@property
|
||||
def updated_at(self) -> datetime:
|
||||
"""Timestamp when the Secret was last updated (RFC 3339 format)"""
|
||||
return self._props["updated_at"]
|
||||
|
||||
@property
|
||||
def name(self) -> str:
|
||||
"""Name of secret"""
|
||||
return self._props["name"]
|
||||
|
||||
@property
|
||||
def description(self) -> str:
|
||||
"""description of Secret"""
|
||||
return self._props["description"]
|
||||
|
||||
@property
|
||||
def metadata(self) -> str:
|
||||
"""Arbitrary user-defined metadata for this Secret"""
|
||||
return self._props["metadata"]
|
||||
|
||||
@property
|
||||
def created_by(self) -> Ref:
|
||||
"""Reference to who created this Secret"""
|
||||
return self._props["created_by"]
|
||||
|
||||
@property
|
||||
def last_updated_by(self) -> Ref:
|
||||
"""Reference to who created this Secret"""
|
||||
return self._props["last_updated_by"]
|
||||
|
||||
@property
|
||||
def vault(self) -> Ref:
|
||||
"""Reference to the vault the secret is stored in"""
|
||||
return self._props["vault"]
|
||||
|
||||
|
||||
class SecretList(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["secrets"] = (
|
||||
[Secret(client, x) for x in props["secrets"]]
|
||||
if props.get("secrets") is not None
|
||||
else []
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<SecretList {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<SecretList {}>".format(repr(self._props))
|
||||
|
||||
def __iter__(self):
|
||||
return PagedIterator(self._client, self, "secrets")
|
||||
|
||||
@property
|
||||
def secrets(self) -> Sequence[Secret]:
|
||||
"""The list of Secrets for this account"""
|
||||
return self._props["secrets"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def next_page_uri(self) -> str:
|
||||
"""URI of the next page of results, or null if there is no next page"""
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class SSHCertificateAuthority(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
@@ -5928,3 +6050,120 @@ class TunnelList(object):
|
||||
def next_page_uri(self) -> str:
|
||||
"""URI of the next page, or null if there is no next page"""
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class Vault(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<Vault {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<Vault {}>".format(repr(self._props))
|
||||
|
||||
def update(
|
||||
self,
|
||||
name: str = None,
|
||||
metadata: str = None,
|
||||
description: str = None,
|
||||
):
|
||||
self._client.vaults.update(
|
||||
id=self.id,
|
||||
name=name,
|
||||
metadata=metadata,
|
||||
description=description,
|
||||
)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
):
|
||||
self._client.vaults.delete(
|
||||
id=self.id,
|
||||
)
|
||||
|
||||
@property
|
||||
def id(self) -> str:
|
||||
"""identifier for Vault"""
|
||||
return self._props["id"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of this Vault API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def created_at(self) -> datetime:
|
||||
"""Timestamp when the Vault was created (RFC 3339 format)"""
|
||||
return self._props["created_at"]
|
||||
|
||||
@property
|
||||
def updated_at(self) -> datetime:
|
||||
"""Timestamp when the Vault was last updated (RFC 3339 format)"""
|
||||
return self._props["updated_at"]
|
||||
|
||||
@property
|
||||
def name(self) -> str:
|
||||
"""Name of vault"""
|
||||
return self._props["name"]
|
||||
|
||||
@property
|
||||
def description(self) -> str:
|
||||
"""description of Vault"""
|
||||
return self._props["description"]
|
||||
|
||||
@property
|
||||
def metadata(self) -> str:
|
||||
"""Arbitrary user-defined metadata for this Vault"""
|
||||
return self._props["metadata"]
|
||||
|
||||
@property
|
||||
def created_by(self) -> str:
|
||||
"""Reference to who created this Vault"""
|
||||
return self._props["created_by"]
|
||||
|
||||
@property
|
||||
def last_updated_by(self) -> str:
|
||||
"""Reference to who created this Vault"""
|
||||
return self._props["last_updated_by"]
|
||||
|
||||
|
||||
class VaultList(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["vaults"] = (
|
||||
[Vault(client, x) for x in props["vaults"]]
|
||||
if props.get("vaults") is not None
|
||||
else []
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<VaultList {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<VaultList {}>".format(repr(self._props))
|
||||
|
||||
def __iter__(self):
|
||||
return PagedIterator(self._client, self, "vaults")
|
||||
|
||||
@property
|
||||
def vaults(self) -> Sequence[Vault]:
|
||||
"""The list of Vaults for this account"""
|
||||
return self._props["vaults"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def next_page_uri(self) -> str:
|
||||
"""URI of the next page of results, or null if there is no next page"""
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
@@ -4617,6 +4617,128 @@ class ReservedDomainsClient(object):
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
|
||||
class SecretsClient(object):
|
||||
"""Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def create(
|
||||
self,
|
||||
vault_id: str,
|
||||
name: str = "",
|
||||
value: str = "",
|
||||
metadata: str = "",
|
||||
description: str = "",
|
||||
) -> Secret:
|
||||
"""Create a new Secret
|
||||
|
||||
:param name: Name of secret
|
||||
:param value: Value of secret
|
||||
:param metadata: Arbitrary user-defined metadata for this Secret
|
||||
:param description: description of Secret
|
||||
:param vault_id: unique identifier of the referenced vault
|
||||
|
||||
https://ngrok.com/docs/api#api-secrets-create
|
||||
"""
|
||||
path = "/vault_secrets"
|
||||
body_arg = dict(
|
||||
name=name,
|
||||
value=value,
|
||||
metadata=metadata,
|
||||
description=description,
|
||||
vault_id=vault_id,
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return Secret(self._client, result)
|
||||
|
||||
def update(
|
||||
self,
|
||||
id: str,
|
||||
name: str = None,
|
||||
value: str = None,
|
||||
metadata: str = None,
|
||||
description: str = None,
|
||||
) -> Secret:
|
||||
"""Update an existing Secret by ID
|
||||
|
||||
:param id: identifier for Secret
|
||||
:param name: Name of secret
|
||||
:param value: Value of secret
|
||||
:param metadata: Arbitrary user-defined metadata for this Secret
|
||||
:param description: description of Secret
|
||||
|
||||
https://ngrok.com/docs/api#api-secrets-update
|
||||
"""
|
||||
path = "/vault_secrets/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = dict(
|
||||
name=name,
|
||||
value=value,
|
||||
metadata=metadata,
|
||||
description=description,
|
||||
)
|
||||
result = self._client.http_client.patch(path, body_arg)
|
||||
return Secret(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete a Secret
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-secrets-delete
|
||||
"""
|
||||
path = "/vault_secrets/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> Secret:
|
||||
"""Get a Secret by ID
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-secrets-get
|
||||
"""
|
||||
path = "/vault_secrets/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return Secret(self._client, result)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
) -> SecretList:
|
||||
"""List all Secrets owned by account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
|
||||
https://ngrok.com/docs/api#api-secrets-list
|
||||
"""
|
||||
path = "/vault_secrets"
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return SecretList(self._client, result)
|
||||
|
||||
|
||||
class SSHCertificateAuthoritiesClient(object):
|
||||
"""An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
||||
key that can be used to sign other SSH host and user certificates."""
|
||||
@@ -5269,3 +5391,116 @@ class TunnelsClient(object):
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return Tunnel(self._client, result)
|
||||
|
||||
|
||||
class VaultsClient(object):
|
||||
"""Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens."""
|
||||
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def create(
|
||||
self,
|
||||
name: str = "",
|
||||
metadata: str = "",
|
||||
description: str = "",
|
||||
) -> Vault:
|
||||
"""Create a new Vault
|
||||
|
||||
:param name: Name of vault
|
||||
:param metadata: Arbitrary user-defined metadata for this Vault
|
||||
:param description: description of Vault
|
||||
|
||||
https://ngrok.com/docs/api#api-vaults-create
|
||||
"""
|
||||
path = "/vaults"
|
||||
body_arg = dict(
|
||||
name=name,
|
||||
metadata=metadata,
|
||||
description=description,
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return Vault(self._client, result)
|
||||
|
||||
def update(
|
||||
self,
|
||||
id: str,
|
||||
name: str = None,
|
||||
metadata: str = None,
|
||||
description: str = None,
|
||||
) -> Vault:
|
||||
"""Update an existing Vault by ID
|
||||
|
||||
:param id: identifier for Vault
|
||||
:param name: Name of vault
|
||||
:param metadata: Arbitrary user-defined metadata for this Vault
|
||||
:param description: description of Vault
|
||||
|
||||
https://ngrok.com/docs/api#api-vaults-update
|
||||
"""
|
||||
path = "/vaults/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = dict(
|
||||
name=name,
|
||||
metadata=metadata,
|
||||
description=description,
|
||||
)
|
||||
result = self._client.http_client.patch(path, body_arg)
|
||||
return Vault(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete a Vault
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-vaults-delete
|
||||
"""
|
||||
path = "/vaults/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> Vault:
|
||||
"""Get a Vault by ID
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-vaults-get
|
||||
"""
|
||||
path = "/vaults/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return Vault(self._client, result)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
) -> VaultList:
|
||||
"""List all Vaults owned by account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
|
||||
https://ngrok.com/docs/api#api-vaults-list
|
||||
"""
|
||||
path = "/vaults"
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return VaultList(self._client, result)
|
||||
|
||||
Reference in New Issue
Block a user