mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-06-16 16:54:33 +00:00
3292 lines
349 KiB
HTML
3292 lines
349 KiB
HTML
<!doctype html>
|
|
<html class="no-js">
|
|
<head><meta charset="utf-8"/>
|
|
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
|
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" />
|
|
|
|
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
|
<title>ngrok.services - ngrok-api documentation</title>
|
|
<link rel="stylesheet" href="../../_static/styles/furo.css?digest=59ab60ac09ea94ccfe6deddff6d715cce948a6fc">
|
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
|
<link media="(prefers-color-scheme: dark)" rel="stylesheet" href="../../_static/pygments_dark.css">
|
|
|
|
|
|
|
|
<style>
|
|
:root {
|
|
--color-code-background: #f8f8f8;
|
|
--color-code-foreground: black;
|
|
|
|
}
|
|
@media (prefers-color-scheme: dark) {
|
|
:root {
|
|
--color-code-background: #202020;
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
}
|
|
}
|
|
|
|
/* For allowing end-user-specific overrides */
|
|
.override-light {
|
|
--color-code-background: #f8f8f8;
|
|
--color-code-foreground: black;
|
|
|
|
}
|
|
.override-dark {
|
|
--color-code-background: #202020;
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
}
|
|
</style><link rel="stylesheet" href="../../_static/styles/furo-extensions.css?digest=d391b54134226e4196576da3bdb6dddb7e05ba2b"></head>
|
|
<body dir="">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
<title>Contents</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
|
stroke-width="1.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round">
|
|
<path stroke="none" d="M0 0h24v24H0z"/>
|
|
<line x1="4" y1="6" x2="20" y2="6" />
|
|
<line x1="10" y1="12" x2="20" y2="12" />
|
|
<line x1="6" y1="18" x2="20" y2="18" />
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
<title>Menu</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
|
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
|
class="feather feather-menu">
|
|
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
<title>Expand</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
|
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
|
class="feather feather-chevron-right">
|
|
<polyline points="9 18 15 12 9 6"></polyline>
|
|
</svg>
|
|
</symbol>
|
|
</svg>
|
|
|
|
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
|
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
|
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
|
<label class="overlay toc-overlay" for="__toc"></label>
|
|
|
|
|
|
|
|
<div class="page">
|
|
<header class="mobile-header">
|
|
<div class="header-left">
|
|
<label class="nav-overlay-icon" for="__navigation">
|
|
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
</label>
|
|
</div>
|
|
<div class="header-center">
|
|
<a href="../../index.html"><div class="brand">ngrok-api documentation</div></a>
|
|
</div>
|
|
<div class="header-right">
|
|
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
</label>
|
|
</div>
|
|
</header>
|
|
<aside class="sidebar-drawer">
|
|
<div class="sidebar-container">
|
|
|
|
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
|
|
|
|
|
|
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
|
|
|
</a><form class="sidebar-search-container" method="get" action="../../search.html">
|
|
<input class="sidebar-search" placeholder=Search name="q">
|
|
<input type="hidden" name="check_keywords" value="yes">
|
|
<input type="hidden" name="area" value="default">
|
|
</form><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
<p class="caption"><span class="caption-text">API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../client.html">Client</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../datatypes.html">Datatypes</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../errors.html">Errors</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Services</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../abuse_reports.html">Abuse Reports</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../api_keys.html">API Keys</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../certificate_authorities.html">Certificate Authorities</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../credentials.html">Tunnel Credentials</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../event_streams.html">Event Streams</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../event_destinations.html">Event Destinations</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../ip_policies.html">IP Policies</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../ip_policy_rules.html">IP Policy Rules</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../ip_restrictions.html">IP Restrictions</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../ip_whitelist.html">IP Whitelist</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_configurations.html">Endpoint Configurations</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_logging_module.html">Logging Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_compression_module.html">Compression Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_tls_termination_module.html">TLS Termination Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_ip_policy_module.html">IP Policy Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_request_headers_module.html">Request Headers Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_response_headers_module.html">Response Headers Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_o_auth_module.html">OAuth Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_saml_module.html">SAML Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../endpoint_oidc_module.html">OIDC Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../reserved_addrs.html">Reserved Addresses</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../reserved_domains.html">Reserved Domains</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../ssh_credentials.html">SSH Credentials</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../ssh_host_certificates.html">SSH Host Certificates</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../ssh_user_certificates.html">SSH User Certificates</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../tls_certificates.html">TLS Certificates</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_sessions.html">Tunnel Sessions</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../tunnels.html">Tunnels</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</aside>
|
|
<main class="main">
|
|
<div class="content">
|
|
<article role="main">
|
|
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
</label>
|
|
<h1>Source code for ngrok.services</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
|
|
<span class="kn">from</span> <span class="nn">collections.abc</span> <span class="kn">import</span> <span class="n">Iterator</span>
|
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Sequence</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">.http_client</span> <span class="kn">import</span> <span class="n">HTTPClient</span>
|
|
<span class="kn">from</span> <span class="nn">.datatypes</span> <span class="kn">import</span> <span class="o">*</span>
|
|
|
|
|
|
<div class="viewcode-block" id="AbuseReportsClient"><a class="viewcode-back" href="../../abuse_reports.html#ngrok.services.AbuseReportsClient">[docs]</a><span class="k">class</span> <span class="nc">AbuseReportsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="AbuseReportsClient.create"><a class="viewcode-back" href="../../abuse_reports.html#ngrok.services.AbuseReportsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">urls</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
|
|
<span class="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="p">)</span> <span class="o">-></span> <span class="n">AbuseReport</span><span class="p">:</span>
|
|
<span class="sd">"""Creates a new abuse report which will be reviewed by our system and abuse response team. This API is only available to authorized accounts. Contact abuse@ngrok.com to request access</span>
|
|
|
|
<span class="sd"> :param urls: a list of URLs containing suspected abusive content</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-abuse-reports-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/abuse_reports"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">urls</span><span class="o">=</span><span class="n">urls</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="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">AbuseReport</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="AbuseReportsClient.get"><a class="viewcode-back" href="../../abuse_reports.html#ngrok.services.AbuseReportsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">AbuseReport</span><span class="p">:</span>
|
|
<span class="sd">"""Get the detailed status of abuse report by ID.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-abuse-reports-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/abuse_reports/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">AbuseReport</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="APIKeysClient"><a class="viewcode-back" href="../../api_keys.html#ngrok.services.APIKeysClient">[docs]</a><span class="k">class</span> <span class="nc">APIKeysClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="APIKeysClient.create"><a class="viewcode-back" href="../../api_keys.html#ngrok.services.APIKeysClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">APIKey</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new API key. The generated API key can be used to authenticate to the ngrok API.</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined data of this API key. optional, max 4096 bytes</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-api-keys-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/api_keys"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">APIKey</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="APIKeysClient.delete"><a class="viewcode-back" href="../../api_keys.html#ngrok.services.APIKeysClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an API key by ID</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-api-keys-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/api_keys/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="APIKeysClient.get"><a class="viewcode-back" href="../../api_keys.html#ngrok.services.APIKeysClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">APIKey</span><span class="p">:</span>
|
|
<span class="sd">"""Get the details of an API key by ID.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-api-keys-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/api_keys/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">APIKey</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="APIKeysClient.list"><a class="viewcode-back" href="../../api_keys.html#ngrok.services.APIKeysClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">APIKeyList</span><span class="p">:</span>
|
|
<span class="sd">"""List all API keys owned by this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-api-keys-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/api_keys"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">APIKeyList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="APIKeysClient.update"><a class="viewcode-back" href="../../api_keys.html#ngrok.services.APIKeysClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">APIKey</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of an API key by ID.</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined data of this API key. optional, max 4096 bytes</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-api-keys-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/api_keys/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">APIKey</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="CertificateAuthoritiesClient"><a class="viewcode-back" href="../../certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient">[docs]</a><span class="k">class</span> <span class="nc">CertificateAuthoritiesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="CertificateAuthoritiesClient.create"><a class="viewcode-back" href="../../certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">ca_pem</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="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="p">)</span> <span class="o">-></span> <span class="n">CertificateAuthority</span><span class="p">:</span>
|
|
<span class="sd">"""Upload a new Certificate Authority</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of this Certificate Authority. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param ca_pem: raw PEM of the Certificate Authority</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-certificate-authorities-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/certificate_authorities"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">ca_pem</span><span class="o">=</span><span class="n">ca_pem</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">CertificateAuthority</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="CertificateAuthoritiesClient.delete"><a class="viewcode-back" href="../../certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete a Certificate Authority</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-certificate-authorities-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/certificate_authorities/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="CertificateAuthoritiesClient.get"><a class="viewcode-back" href="../../certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">CertificateAuthority</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about a certficate authority</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-certificate-authorities-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/certificate_authorities/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">CertificateAuthority</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="CertificateAuthoritiesClient.list"><a class="viewcode-back" href="../../certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">CertificateAuthorityList</span><span class="p">:</span>
|
|
<span class="sd">"""List all Certificate Authority on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-certificate-authorities-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/certificate_authorities"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">CertificateAuthorityList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="CertificateAuthoritiesClient.update"><a class="viewcode-back" href="../../certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">CertificateAuthority</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of a Certificate Authority by ID</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of this Certificate Authority. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-certificate-authorities-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/certificate_authorities/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">CertificateAuthority</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="CredentialsClient"><a class="viewcode-back" href="../../credentials.html#ngrok.services.CredentialsClient">[docs]</a><span class="k">class</span> <span class="nc">CredentialsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="CredentialsClient.create"><a class="viewcode-back" href="../../credentials.html#ngrok.services.CredentialsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">acl</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">Credential</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-credentials-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/credentials"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">acl</span><span class="o">=</span><span class="n">acl</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">Credential</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="CredentialsClient.delete"><a class="viewcode-back" href="../../credentials.html#ngrok.services.CredentialsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete a tunnel authtoken credential by ID</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-credentials-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/credentials/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="CredentialsClient.get"><a class="viewcode-back" href="../../credentials.html#ngrok.services.CredentialsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">Credential</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about a tunnel authtoken credential</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-credentials-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/credentials/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">Credential</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="CredentialsClient.list"><a class="viewcode-back" href="../../credentials.html#ngrok.services.CredentialsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">CredentialList</span><span class="p">:</span>
|
|
<span class="sd">"""List all tunnel authtoken credentials on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-credentials-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/credentials"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">CredentialList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="CredentialsClient.update"><a class="viewcode-back" href="../../credentials.html#ngrok.services.CredentialsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">acl</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">Credential</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of an tunnel authtoken credential by ID</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-credentials-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/credentials/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">acl</span><span class="o">=</span><span class="n">acl</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">Credential</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EventStreamsClient"><a class="viewcode-back" href="../../event_streams.html#ngrok.services.EventStreamsClient">[docs]</a><span class="k">class</span> <span class="nc">EventStreamsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EventStreamsClient.create"><a class="viewcode-back" href="../../event_streams.html#ngrok.services.EventStreamsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">fields</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<span class="n">event_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">destination_ids</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<span class="n">sampling_rate</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EventStream</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new Event Stream. It will not apply to anything until you associate it with one or more Endpoint Configs.</span>
|
|
|
|
<span class="sd"> :param metadata: Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param description: Human-readable description of the Event Stream. Optional, max 255 bytes.</span>
|
|
<span class="sd"> :param fields: A list of protocol-specific fields you want to collect on each event.</span>
|
|
<span class="sd"> :param event_type: The protocol that determines which events will be collected. Supported values are ``tcp_connection_closed`` and ``http_request_complete``.</span>
|
|
<span class="sd"> :param destination_ids: A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</span>
|
|
<span class="sd"> :param sampling_rate: The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-streams-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_streams"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">fields</span><span class="o">=</span><span class="n">fields</span><span class="p">,</span>
|
|
<span class="n">event_type</span><span class="o">=</span><span class="n">event_type</span><span class="p">,</span>
|
|
<span class="n">destination_ids</span><span class="o">=</span><span class="n">destination_ids</span><span class="p">,</span>
|
|
<span class="n">sampling_rate</span><span class="o">=</span><span class="n">sampling_rate</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EventStream</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="EventStreamsClient.delete"><a class="viewcode-back" href="../../event_streams.html#ngrok.services.EventStreamsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an Event Stream. Associated Event Destinations will be preserved.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-streams-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_streams/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="EventStreamsClient.get"><a class="viewcode-back" href="../../event_streams.html#ngrok.services.EventStreamsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EventStream</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an Event Stream by ID.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-streams-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_streams/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EventStream</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="EventStreamsClient.list"><a class="viewcode-back" href="../../event_streams.html#ngrok.services.EventStreamsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EventStreamList</span><span class="p">:</span>
|
|
<span class="sd">"""List all Event Streams available on this account.</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-streams-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_streams"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EventStreamList</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="EventStreamsClient.update"><a class="viewcode-back" href="../../event_streams.html#ngrok.services.EventStreamsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">fields</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">destination_ids</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">sampling_rate</span><span class="p">:</span> <span class="nb">float</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">EventStream</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of an Event Stream by ID.</span>
|
|
|
|
<span class="sd"> :param id: Unique identifier for this Event Stream.</span>
|
|
<span class="sd"> :param metadata: Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param description: Human-readable description of the Event Stream. Optional, max 255 bytes.</span>
|
|
<span class="sd"> :param fields: A list of protocol-specific fields you want to collect on each event.</span>
|
|
<span class="sd"> :param destination_ids: A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</span>
|
|
<span class="sd"> :param sampling_rate: The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-streams-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_streams/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">fields</span><span class="o">=</span><span class="n">fields</span><span class="p">,</span>
|
|
<span class="n">destination_ids</span><span class="o">=</span><span class="n">destination_ids</span><span class="p">,</span>
|
|
<span class="n">sampling_rate</span><span class="o">=</span><span class="n">sampling_rate</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EventStream</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="EventDestinationsClient"><a class="viewcode-back" href="../../event_destinations.html#ngrok.services.EventDestinationsClient">[docs]</a><span class="k">class</span> <span class="nc">EventDestinationsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EventDestinationsClient.create"><a class="viewcode-back" href="../../event_destinations.html#ngrok.services.EventDestinationsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="nb">format</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">target</span><span class="p">:</span> <span class="n">EventTarget</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">EventDestination</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new Event Destination. It will not apply to anything until it is associated with an Event Stream, and that Event Stream is associated with an Endpoint Config.</span>
|
|
|
|
<span class="sd"> :param metadata: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param description: Human-readable description of the Event Destination. Optional, max 255 bytes.</span>
|
|
<span class="sd"> :param format: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is ``JSON``.</span>
|
|
<span class="sd"> :param target: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: ``kinesis``, ``firehose``, ``cloudwatch_logs``, or ``s3``.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-destinations-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_destinations"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="nb">format</span><span class="o">=</span><span class="nb">format</span><span class="p">,</span>
|
|
<span class="n">target</span><span class="o">=</span><span class="n">target</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EventDestination</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="EventDestinationsClient.delete"><a class="viewcode-back" href="../../event_destinations.html#ngrok.services.EventDestinationsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an Event Destination. If the Event Destination is still referenced by an Event Stream, this will throw an error until that Event Stream has removed that reference.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-destinations-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_destinations/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="EventDestinationsClient.get"><a class="viewcode-back" href="../../event_destinations.html#ngrok.services.EventDestinationsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EventDestination</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an Event Destination by ID.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-destinations-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_destinations/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EventDestination</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="EventDestinationsClient.list"><a class="viewcode-back" href="../../event_destinations.html#ngrok.services.EventDestinationsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EventDestinationList</span><span class="p">:</span>
|
|
<span class="sd">"""List all Event Destinations on this account.</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-destinations-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_destinations"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EventDestinationList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="EventDestinationsClient.update"><a class="viewcode-back" href="../../event_destinations.html#ngrok.services.EventDestinationsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="nb">format</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">target</span><span class="p">:</span> <span class="n">EventTarget</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">EventDestination</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of an Event Destination.</span>
|
|
|
|
<span class="sd"> :param id: Unique identifier for this Event Destination.</span>
|
|
<span class="sd"> :param metadata: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param description: Human-readable description of the Event Destination. Optional, max 255 bytes.</span>
|
|
<span class="sd"> :param format: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is ``JSON``.</span>
|
|
<span class="sd"> :param target: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: ``kinesis``, ``firehose``, ``cloudwatch_logs``, or ``s3``.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-event-destinations-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/event_destinations/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="nb">format</span><span class="o">=</span><span class="nb">format</span><span class="p">,</span>
|
|
<span class="n">target</span><span class="o">=</span><span class="n">target</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EventDestination</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="IPPoliciesClient"><a class="viewcode-back" href="../../ip_policies.html#ngrok.services.IPPoliciesClient">[docs]</a><span class="k">class</span> <span class="nc">IPPoliciesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="IPPoliciesClient.create"><a class="viewcode-back" href="../../ip_policies.html#ngrok.services.IPPoliciesClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">action</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="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="p">)</span> <span class="o">-></span> <span class="n">IPPolicy</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of the source IPs of this IP policy. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param action: the IP policy action. Supported values are ``allow`` or ``deny``</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policies-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policies"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">action</span><span class="o">=</span><span class="n">action</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPPolicy</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="IPPoliciesClient.delete"><a class="viewcode-back" href="../../ip_policies.html#ngrok.services.IPPoliciesClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policies-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policies/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="IPPoliciesClient.get"><a class="viewcode-back" href="../../ip_policies.html#ngrok.services.IPPoliciesClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPPolicy</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an IP policy by ID.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policies-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policies/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">IPPolicy</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="IPPoliciesClient.list"><a class="viewcode-back" href="../../ip_policies.html#ngrok.services.IPPoliciesClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPPolicyList</span><span class="p">:</span>
|
|
<span class="sd">"""List all IP policies on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policies-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policies"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPPolicyList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="IPPoliciesClient.update"><a class="viewcode-back" href="../../ip_policies.html#ngrok.services.IPPoliciesClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPPolicy</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of an IP policy by ID</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of the source IPs of this IP policy. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policies-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policies/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPPolicy</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="IPPolicyRulesClient"><a class="viewcode-back" href="../../ip_policy_rules.html#ngrok.services.IPPolicyRulesClient">[docs]</a><span class="k">class</span> <span class="nc">IPPolicyRulesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="IPPolicyRulesClient.create"><a class="viewcode-back" href="../../ip_policy_rules.html#ngrok.services.IPPolicyRulesClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">cidr</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">ip_policy_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="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="p">)</span> <span class="o">-></span> <span class="n">IPPolicyRule</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new IP policy rule attached to an IP Policy.</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of the source IPs of this IP rule. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param cidr: an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.</span>
|
|
<span class="sd"> :param ip_policy_id: ID of the IP policy this IP policy rule will be attached to</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policy-rules-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policy_rules"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">cidr</span><span class="o">=</span><span class="n">cidr</span><span class="p">,</span>
|
|
<span class="n">ip_policy_id</span><span class="o">=</span><span class="n">ip_policy_id</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPPolicyRule</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="IPPolicyRulesClient.delete"><a class="viewcode-back" href="../../ip_policy_rules.html#ngrok.services.IPPolicyRulesClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an IP policy rule.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policy-rules-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policy_rules/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="IPPolicyRulesClient.get"><a class="viewcode-back" href="../../ip_policy_rules.html#ngrok.services.IPPolicyRulesClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPPolicyRule</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an IP policy rule by ID.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policy-rules-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policy_rules/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">IPPolicyRule</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="IPPolicyRulesClient.list"><a class="viewcode-back" href="../../ip_policy_rules.html#ngrok.services.IPPolicyRulesClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPPolicyRuleList</span><span class="p">:</span>
|
|
<span class="sd">"""List all IP policy rules on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policy-rules-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policy_rules"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPPolicyRuleList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="IPPolicyRulesClient.update"><a class="viewcode-back" href="../../ip_policy_rules.html#ngrok.services.IPPolicyRulesClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">cidr</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">IPPolicyRule</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of an IP policy rule by ID</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of the source IPs of this IP rule. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param cidr: an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-policy-rules-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_policy_rules/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">cidr</span><span class="o">=</span><span class="n">cidr</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPPolicyRule</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="IPRestrictionsClient"><a class="viewcode-back" href="../../ip_restrictions.html#ngrok.services.IPRestrictionsClient">[docs]</a><span class="k">class</span> <span class="nc">IPRestrictionsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="IPRestrictionsClient.create"><a class="viewcode-back" href="../../ip_restrictions.html#ngrok.services.IPRestrictionsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">ip_policy_ids</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">enforced</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPRestriction</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new IP restriction</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of this IP restriction. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param enforced: true if the IP restriction will be enforce. if false, only warnings will be issued</span>
|
|
<span class="sd"> :param type: the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: ``dashboard``, ``api``, ``agent``, and ``endpoints``</span>
|
|
<span class="sd"> :param ip_policy_ids: the set of IP policy identifiers that are used to enforce the restriction</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-restrictions-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_restrictions"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">enforced</span><span class="o">=</span><span class="n">enforced</span><span class="p">,</span>
|
|
<span class="nb">type</span><span class="o">=</span><span class="nb">type</span><span class="p">,</span>
|
|
<span class="n">ip_policy_ids</span><span class="o">=</span><span class="n">ip_policy_ids</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPRestriction</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="IPRestrictionsClient.delete"><a class="viewcode-back" href="../../ip_restrictions.html#ngrok.services.IPRestrictionsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an IP restriction</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-restrictions-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_restrictions/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="IPRestrictionsClient.get"><a class="viewcode-back" href="../../ip_restrictions.html#ngrok.services.IPRestrictionsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPRestriction</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an IP restriction</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-restrictions-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_restrictions/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">IPRestriction</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="IPRestrictionsClient.list"><a class="viewcode-back" href="../../ip_restrictions.html#ngrok.services.IPRestrictionsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPRestrictionList</span><span class="p">:</span>
|
|
<span class="sd">"""List all IP restrictions on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-restrictions-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_restrictions"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPRestrictionList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="IPRestrictionsClient.update"><a class="viewcode-back" href="../../ip_restrictions.html#ngrok.services.IPRestrictionsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">enforced</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">ip_policy_ids</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPRestriction</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of an IP restriction by ID</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of this IP restriction. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param enforced: true if the IP restriction will be enforce. if false, only warnings will be issued</span>
|
|
<span class="sd"> :param ip_policy_ids: the set of IP policy identifiers that are used to enforce the restriction</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-restrictions-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_restrictions/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">enforced</span><span class="o">=</span><span class="n">enforced</span><span class="p">,</span>
|
|
<span class="n">ip_policy_ids</span><span class="o">=</span><span class="n">ip_policy_ids</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPRestriction</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="IPWhitelistClient"><a class="viewcode-back" href="../../ip_whitelist.html#ngrok.services.IPWhitelistClient">[docs]</a><span class="k">class</span> <span class="nc">IPWhitelistClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="IPWhitelistClient.create"><a class="viewcode-back" href="../../ip_whitelist.html#ngrok.services.IPWhitelistClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">ip_net</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">IPWhitelistEntry</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new IP whitelist entry that will restrict traffic to all tunnel endpoints on the account.</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param ip_net: an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-whitelist-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_whitelist"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">ip_net</span><span class="o">=</span><span class="n">ip_net</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPWhitelistEntry</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="IPWhitelistClient.delete"><a class="viewcode-back" href="../../ip_whitelist.html#ngrok.services.IPWhitelistClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an IP whitelist entry.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-whitelist-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_whitelist/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="IPWhitelistClient.get"><a class="viewcode-back" href="../../ip_whitelist.html#ngrok.services.IPWhitelistClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPWhitelistEntry</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an IP whitelist entry by ID.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-whitelist-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_whitelist/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">IPWhitelistEntry</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="IPWhitelistClient.list"><a class="viewcode-back" href="../../ip_whitelist.html#ngrok.services.IPWhitelistClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPWhitelistEntryList</span><span class="p">:</span>
|
|
<span class="sd">"""List all IP whitelist entries on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-whitelist-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_whitelist"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPWhitelistEntryList</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="IPWhitelistClient.update"><a class="viewcode-back" href="../../ip_whitelist.html#ngrok.services.IPWhitelistClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">IPWhitelistEntry</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of an IP whitelist entry by ID</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ip-whitelist-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ip_whitelist/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">IPWhitelistEntry</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointConfigurationsClient"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointConfigurationsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="sd">"""Endpoint Configuration managementAn `Endpoint Configuration` <https://ngrok.com/docs/ngrok-link#api-endpoint-configurations>`_ describes</span>
|
|
<span class="sd"> a ngrok network endpoint instance.*Endpoints are your gateway to ngrok features!*"""</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointConfigurationsClient.create"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">circuit_breaker</span><span class="p">:</span> <span class="n">EndpointCircuitBreaker</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">compression</span><span class="p">:</span> <span class="n">EndpointCompression</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">request_headers</span><span class="p">:</span> <span class="n">EndpointRequestHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">response_headers</span><span class="p">:</span> <span class="n">EndpointResponseHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">ip_policy</span><span class="p">:</span> <span class="n">EndpointIPPolicyMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">mutual_tls</span><span class="p">:</span> <span class="n">EndpointMutualTLSMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">tls_termination</span><span class="p">:</span> <span class="n">EndpointTLSTermination</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">webhook_validation</span><span class="p">:</span> <span class="n">EndpointWebhookValidation</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">oauth</span><span class="p">:</span> <span class="n">EndpointOAuth</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">logging</span><span class="p">:</span> <span class="n">EndpointLoggingMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">saml</span><span class="p">:</span> <span class="n">EndpointSAMLMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">oidc</span><span class="p">:</span> <span class="n">EndpointOIDC</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointConfiguration</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new endpoint configuration</span>
|
|
|
|
<span class="sd"> :param type: they type of traffic this endpoint configuration can be applied to. one of: ``http``, ``https``, ``tcp``</span>
|
|
<span class="sd"> :param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param circuit_breaker: circuit breaker module configuration or ``null``</span>
|
|
<span class="sd"> :param compression: compression module configuration or ``null``</span>
|
|
<span class="sd"> :param request_headers: request headers module configuration or ``null``</span>
|
|
<span class="sd"> :param response_headers: response headers module configuration or ``null``</span>
|
|
<span class="sd"> :param ip_policy: ip policy module configuration or ``null``</span>
|
|
<span class="sd"> :param mutual_tls: mutual TLS module configuration or ``null``</span>
|
|
<span class="sd"> :param tls_termination: TLS termination module configuration or ``null``</span>
|
|
<span class="sd"> :param webhook_validation: webhook validation module configuration or ``null``</span>
|
|
<span class="sd"> :param oauth: oauth module configuration or ``null``</span>
|
|
<span class="sd"> :param logging: logging module configuration or ``null``</span>
|
|
<span class="sd"> :param saml: saml module configuration or ``null``</span>
|
|
<span class="sd"> :param oidc: oidc module configuration or ``null``</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-configurations-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="nb">type</span><span class="o">=</span><span class="nb">type</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">circuit_breaker</span><span class="o">=</span><span class="n">circuit_breaker</span><span class="p">,</span>
|
|
<span class="n">compression</span><span class="o">=</span><span class="n">compression</span><span class="p">,</span>
|
|
<span class="n">request_headers</span><span class="o">=</span><span class="n">request_headers</span><span class="p">,</span>
|
|
<span class="n">response_headers</span><span class="o">=</span><span class="n">response_headers</span><span class="p">,</span>
|
|
<span class="n">ip_policy</span><span class="o">=</span><span class="n">ip_policy</span><span class="p">,</span>
|
|
<span class="n">mutual_tls</span><span class="o">=</span><span class="n">mutual_tls</span><span class="p">,</span>
|
|
<span class="n">tls_termination</span><span class="o">=</span><span class="n">tls_termination</span><span class="p">,</span>
|
|
<span class="n">webhook_validation</span><span class="o">=</span><span class="n">webhook_validation</span><span class="p">,</span>
|
|
<span class="n">oauth</span><span class="o">=</span><span class="n">oauth</span><span class="p">,</span>
|
|
<span class="n">logging</span><span class="o">=</span><span class="n">logging</span><span class="p">,</span>
|
|
<span class="n">saml</span><span class="o">=</span><span class="n">saml</span><span class="p">,</span>
|
|
<span class="n">oidc</span><span class="o">=</span><span class="n">oidc</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointConfiguration</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="EndpointConfigurationsClient.delete"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-configurations-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="EndpointConfigurationsClient.get"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointConfiguration</span><span class="p">:</span>
|
|
<span class="sd">"""Returns detailed information about an endpoint configuration</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-configurations-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointConfiguration</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="EndpointConfigurationsClient.list"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointConfigurationList</span><span class="p">:</span>
|
|
<span class="sd">"""Returns a list of all endpoint configurations on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-configurations-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointConfigurationList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="EndpointConfigurationsClient.update"><a class="viewcode-back" href="../../endpoint_configurations.html#ngrok.services.EndpointConfigurationsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">circuit_breaker</span><span class="p">:</span> <span class="n">EndpointCircuitBreaker</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">compression</span><span class="p">:</span> <span class="n">EndpointCompression</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">request_headers</span><span class="p">:</span> <span class="n">EndpointRequestHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">response_headers</span><span class="p">:</span> <span class="n">EndpointResponseHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">ip_policy</span><span class="p">:</span> <span class="n">EndpointIPPolicyMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">mutual_tls</span><span class="p">:</span> <span class="n">EndpointMutualTLSMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">tls_termination</span><span class="p">:</span> <span class="n">EndpointTLSTermination</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">webhook_validation</span><span class="p">:</span> <span class="n">EndpointWebhookValidation</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">oauth</span><span class="p">:</span> <span class="n">EndpointOAuth</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">logging</span><span class="p">:</span> <span class="n">EndpointLoggingMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">saml</span><span class="p">:</span> <span class="n">EndpointSAMLMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">oidc</span><span class="p">:</span> <span class="n">EndpointOIDC</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointConfiguration</span><span class="p">:</span>
|
|
<span class="sd">"""Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</span>
|
|
|
|
<span class="sd"> :param id: unique identifier of this endpoint configuration</span>
|
|
<span class="sd"> :param description: human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param circuit_breaker: circuit breaker module configuration or ``null``</span>
|
|
<span class="sd"> :param compression: compression module configuration or ``null``</span>
|
|
<span class="sd"> :param request_headers: request headers module configuration or ``null``</span>
|
|
<span class="sd"> :param response_headers: response headers module configuration or ``null``</span>
|
|
<span class="sd"> :param ip_policy: ip policy module configuration or ``null``</span>
|
|
<span class="sd"> :param mutual_tls: mutual TLS module configuration or ``null``</span>
|
|
<span class="sd"> :param tls_termination: TLS termination module configuration or ``null``</span>
|
|
<span class="sd"> :param webhook_validation: webhook validation module configuration or ``null``</span>
|
|
<span class="sd"> :param oauth: oauth module configuration or ``null``</span>
|
|
<span class="sd"> :param logging: logging module configuration or ``null``</span>
|
|
<span class="sd"> :param saml: saml module configuration or ``null``</span>
|
|
<span class="sd"> :param oidc: oidc module configuration or ``null``</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-configurations-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">circuit_breaker</span><span class="o">=</span><span class="n">circuit_breaker</span><span class="p">,</span>
|
|
<span class="n">compression</span><span class="o">=</span><span class="n">compression</span><span class="p">,</span>
|
|
<span class="n">request_headers</span><span class="o">=</span><span class="n">request_headers</span><span class="p">,</span>
|
|
<span class="n">response_headers</span><span class="o">=</span><span class="n">response_headers</span><span class="p">,</span>
|
|
<span class="n">ip_policy</span><span class="o">=</span><span class="n">ip_policy</span><span class="p">,</span>
|
|
<span class="n">mutual_tls</span><span class="o">=</span><span class="n">mutual_tls</span><span class="p">,</span>
|
|
<span class="n">tls_termination</span><span class="o">=</span><span class="n">tls_termination</span><span class="p">,</span>
|
|
<span class="n">webhook_validation</span><span class="o">=</span><span class="n">webhook_validation</span><span class="p">,</span>
|
|
<span class="n">oauth</span><span class="o">=</span><span class="n">oauth</span><span class="p">,</span>
|
|
<span class="n">logging</span><span class="o">=</span><span class="n">logging</span><span class="p">,</span>
|
|
<span class="n">saml</span><span class="o">=</span><span class="n">saml</span><span class="p">,</span>
|
|
<span class="n">oidc</span><span class="o">=</span><span class="n">oidc</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointConfiguration</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointLoggingModuleClient"><a class="viewcode-back" href="../../endpoint_logging_module.html#ngrok.services.EndpointLoggingModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointLoggingModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointLoggingModuleClient.replace"><a class="viewcode-back" href="../../endpoint_logging_module.html#ngrok.services.EndpointLoggingModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointLoggingMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointLogging</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-logging-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/logging"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointLogging</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="EndpointLoggingModuleClient.get"><a class="viewcode-back" href="../../endpoint_logging_module.html#ngrok.services.EndpointLoggingModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointLogging</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-logging-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/logging"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointLogging</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="EndpointLoggingModuleClient.delete"><a class="viewcode-back" href="../../endpoint_logging_module.html#ngrok.services.EndpointLoggingModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-logging-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/logging"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointCircuitBreakerModuleClient"><a class="viewcode-back" href="../../endpoint_circuit_breaker_module.html#ngrok.services.EndpointCircuitBreakerModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointCircuitBreakerModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointCircuitBreakerModuleClient.replace"><a class="viewcode-back" href="../../endpoint_circuit_breaker_module.html#ngrok.services.EndpointCircuitBreakerModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointCircuitBreaker</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointCircuitBreaker</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/circuit_breaker"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointCircuitBreaker</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="EndpointCircuitBreakerModuleClient.get"><a class="viewcode-back" href="../../endpoint_circuit_breaker_module.html#ngrok.services.EndpointCircuitBreakerModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointCircuitBreaker</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/circuit_breaker"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointCircuitBreaker</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="EndpointCircuitBreakerModuleClient.delete"><a class="viewcode-back" href="../../endpoint_circuit_breaker_module.html#ngrok.services.EndpointCircuitBreakerModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/circuit_breaker"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointCompressionModuleClient"><a class="viewcode-back" href="../../endpoint_compression_module.html#ngrok.services.EndpointCompressionModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointCompressionModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointCompressionModuleClient.replace"><a class="viewcode-back" href="../../endpoint_compression_module.html#ngrok.services.EndpointCompressionModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointCompression</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointCompression</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-compression-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/compression"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointCompression</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="EndpointCompressionModuleClient.get"><a class="viewcode-back" href="../../endpoint_compression_module.html#ngrok.services.EndpointCompressionModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointCompression</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-compression-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/compression"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointCompression</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="EndpointCompressionModuleClient.delete"><a class="viewcode-back" href="../../endpoint_compression_module.html#ngrok.services.EndpointCompressionModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-compression-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/compression"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointTLSTerminationModuleClient"><a class="viewcode-back" href="../../endpoint_tls_termination_module.html#ngrok.services.EndpointTLSTerminationModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointTLSTerminationModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointTLSTerminationModuleClient.replace"><a class="viewcode-back" href="../../endpoint_tls_termination_module.html#ngrok.services.EndpointTLSTerminationModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointTLSTermination</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointTLSTermination</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-tls-termination-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/tls_termination"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointTLSTermination</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="EndpointTLSTerminationModuleClient.get"><a class="viewcode-back" href="../../endpoint_tls_termination_module.html#ngrok.services.EndpointTLSTerminationModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointTLSTermination</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-tls-termination-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/tls_termination"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointTLSTermination</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="EndpointTLSTerminationModuleClient.delete"><a class="viewcode-back" href="../../endpoint_tls_termination_module.html#ngrok.services.EndpointTLSTerminationModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-tls-termination-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/tls_termination"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointIPPolicyModuleClient"><a class="viewcode-back" href="../../endpoint_ip_policy_module.html#ngrok.services.EndpointIPPolicyModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointIPPolicyModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointIPPolicyModuleClient.replace"><a class="viewcode-back" href="../../endpoint_ip_policy_module.html#ngrok.services.EndpointIPPolicyModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointIPPolicyMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointIPPolicy</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-ip-policy-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/ip_policy"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointIPPolicy</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="EndpointIPPolicyModuleClient.get"><a class="viewcode-back" href="../../endpoint_ip_policy_module.html#ngrok.services.EndpointIPPolicyModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointIPPolicy</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-ip-policy-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/ip_policy"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointIPPolicy</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="EndpointIPPolicyModuleClient.delete"><a class="viewcode-back" href="../../endpoint_ip_policy_module.html#ngrok.services.EndpointIPPolicyModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-ip-policy-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/ip_policy"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointMutualTLSModuleClient"><a class="viewcode-back" href="../../endpoint_mutual_tls_module.html#ngrok.services.EndpointMutualTLSModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointMutualTLSModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointMutualTLSModuleClient.replace"><a class="viewcode-back" href="../../endpoint_mutual_tls_module.html#ngrok.services.EndpointMutualTLSModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointMutualTLSMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointMutualTLS</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/mutual_tls"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointMutualTLS</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="EndpointMutualTLSModuleClient.get"><a class="viewcode-back" href="../../endpoint_mutual_tls_module.html#ngrok.services.EndpointMutualTLSModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointMutualTLS</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/mutual_tls"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointMutualTLS</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="EndpointMutualTLSModuleClient.delete"><a class="viewcode-back" href="../../endpoint_mutual_tls_module.html#ngrok.services.EndpointMutualTLSModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/mutual_tls"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointRequestHeadersModuleClient"><a class="viewcode-back" href="../../endpoint_request_headers_module.html#ngrok.services.EndpointRequestHeadersModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointRequestHeadersModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointRequestHeadersModuleClient.replace"><a class="viewcode-back" href="../../endpoint_request_headers_module.html#ngrok.services.EndpointRequestHeadersModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointRequestHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointRequestHeaders</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-request-headers-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/request_headers"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointRequestHeaders</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="EndpointRequestHeadersModuleClient.get"><a class="viewcode-back" href="../../endpoint_request_headers_module.html#ngrok.services.EndpointRequestHeadersModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointRequestHeaders</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-request-headers-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/request_headers"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointRequestHeaders</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="EndpointRequestHeadersModuleClient.delete"><a class="viewcode-back" href="../../endpoint_request_headers_module.html#ngrok.services.EndpointRequestHeadersModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-request-headers-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/request_headers"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointResponseHeadersModuleClient"><a class="viewcode-back" href="../../endpoint_response_headers_module.html#ngrok.services.EndpointResponseHeadersModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointResponseHeadersModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointResponseHeadersModuleClient.replace"><a class="viewcode-back" href="../../endpoint_response_headers_module.html#ngrok.services.EndpointResponseHeadersModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointResponseHeaders</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointResponseHeaders</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-response-headers-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/response_headers"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointResponseHeaders</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="EndpointResponseHeadersModuleClient.get"><a class="viewcode-back" href="../../endpoint_response_headers_module.html#ngrok.services.EndpointResponseHeadersModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointResponseHeaders</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-response-headers-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/response_headers"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointResponseHeaders</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="EndpointResponseHeadersModuleClient.delete"><a class="viewcode-back" href="../../endpoint_response_headers_module.html#ngrok.services.EndpointResponseHeadersModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-response-headers-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/response_headers"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointOAuthModuleClient"><a class="viewcode-back" href="../../endpoint_o_auth_module.html#ngrok.services.EndpointOAuthModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointOAuthModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointOAuthModuleClient.replace"><a class="viewcode-back" href="../../endpoint_o_auth_module.html#ngrok.services.EndpointOAuthModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointOAuth</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointOAuth</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-o-auth-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/oauth"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointOAuth</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="EndpointOAuthModuleClient.get"><a class="viewcode-back" href="../../endpoint_o_auth_module.html#ngrok.services.EndpointOAuthModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointOAuth</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-o-auth-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/oauth"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointOAuth</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="EndpointOAuthModuleClient.delete"><a class="viewcode-back" href="../../endpoint_o_auth_module.html#ngrok.services.EndpointOAuthModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-o-auth-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/oauth"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointWebhookValidationModuleClient"><a class="viewcode-back" href="../../endpoint_webhook_validation_module.html#ngrok.services.EndpointWebhookValidationModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointWebhookValidationModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointWebhookValidationModuleClient.replace"><a class="viewcode-back" href="../../endpoint_webhook_validation_module.html#ngrok.services.EndpointWebhookValidationModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointWebhookValidation</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointWebhookValidation</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/webhook_validation"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointWebhookValidation</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="EndpointWebhookValidationModuleClient.get"><a class="viewcode-back" href="../../endpoint_webhook_validation_module.html#ngrok.services.EndpointWebhookValidationModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointWebhookValidation</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/webhook_validation"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointWebhookValidation</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="EndpointWebhookValidationModuleClient.delete"><a class="viewcode-back" href="../../endpoint_webhook_validation_module.html#ngrok.services.EndpointWebhookValidationModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/webhook_validation"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointSAMLModuleClient"><a class="viewcode-back" href="../../endpoint_saml_module.html#ngrok.services.EndpointSAMLModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointSAMLModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointSAMLModuleClient.replace"><a class="viewcode-back" href="../../endpoint_saml_module.html#ngrok.services.EndpointSAMLModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointSAMLMutate</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointSAML</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-saml-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/saml"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointSAML</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="EndpointSAMLModuleClient.get"><a class="viewcode-back" href="../../endpoint_saml_module.html#ngrok.services.EndpointSAMLModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointSAML</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-saml-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/saml"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointSAML</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="EndpointSAMLModuleClient.delete"><a class="viewcode-back" href="../../endpoint_saml_module.html#ngrok.services.EndpointSAMLModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-saml-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/saml"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="EndpointOIDCModuleClient"><a class="viewcode-back" href="../../endpoint_oidc_module.html#ngrok.services.EndpointOIDCModuleClient">[docs]</a><span class="k">class</span> <span class="nc">EndpointOIDCModuleClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="EndpointOIDCModuleClient.replace"><a class="viewcode-back" href="../../endpoint_oidc_module.html#ngrok.services.EndpointOIDCModuleClient.replace">[docs]</a> <span class="k">def</span> <span class="nf">replace</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">module</span><span class="p">:</span> <span class="n">EndpointOIDC</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointOIDC</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param module:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-oidc-module-replace</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/oidc"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">module</span><span class="o">=</span><span class="n">module</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">EndpointOIDC</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="EndpointOIDCModuleClient.get"><a class="viewcode-back" href="../../endpoint_oidc_module.html#ngrok.services.EndpointOIDCModuleClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointOIDC</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-oidc-module-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/oidc"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">EndpointOIDC</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="EndpointOIDCModuleClient.delete"><a class="viewcode-back" href="../../endpoint_oidc_module.html#ngrok.services.EndpointOIDCModuleClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-endpoint-oidc-module-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/endpoint_configurations/</span><span class="si">{id}</span><span class="s2">/oidc"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ReservedAddrsClient"><a class="viewcode-back" href="../../reserved_addrs.html#ngrok.services.ReservedAddrsClient">[docs]</a><span class="k">class</span> <span class="nc">ReservedAddrsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="ReservedAddrsClient.create"><a class="viewcode-back" href="../../reserved_addrs.html#ngrok.services.ReservedAddrsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">region</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">endpoint_configuration_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">ReservedAddr</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new reserved address.</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of what this reserved address will be used for</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param region: reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</span>
|
|
<span class="sd"> :param endpoint_configuration_id: ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-addrs-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_addrs"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">region</span><span class="o">=</span><span class="n">region</span><span class="p">,</span>
|
|
<span class="n">endpoint_configuration_id</span><span class="o">=</span><span class="n">endpoint_configuration_id</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">ReservedAddr</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="ReservedAddrsClient.delete"><a class="viewcode-back" href="../../reserved_addrs.html#ngrok.services.ReservedAddrsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete a reserved address.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-addrs-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_addrs/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="ReservedAddrsClient.get"><a class="viewcode-back" href="../../reserved_addrs.html#ngrok.services.ReservedAddrsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">ReservedAddr</span><span class="p">:</span>
|
|
<span class="sd">"""Get the details of a reserved address.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-addrs-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_addrs/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">ReservedAddr</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="ReservedAddrsClient.list"><a class="viewcode-back" href="../../reserved_addrs.html#ngrok.services.ReservedAddrsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">ReservedAddrList</span><span class="p">:</span>
|
|
<span class="sd">"""List all reserved addresses on this account.</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-addrs-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_addrs"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">ReservedAddrList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="ReservedAddrsClient.update"><a class="viewcode-back" href="../../reserved_addrs.html#ngrok.services.ReservedAddrsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">endpoint_configuration_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">ReservedAddr</span><span class="p">:</span>
|
|
<span class="sd">"""Update the attributes of a reserved address.</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of what this reserved address will be used for</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param endpoint_configuration_id: ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-addrs-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_addrs/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">endpoint_configuration_id</span><span class="o">=</span><span class="n">endpoint_configuration_id</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">ReservedAddr</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="ReservedAddrsClient.delete_endpoint_config"><a class="viewcode-back" href="../../reserved_addrs.html#ngrok.services.ReservedAddrsClient.delete_endpoint_config">[docs]</a> <span class="k">def</span> <span class="nf">delete_endpoint_config</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Detach the endpoint configuration attached to a reserved address.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_addrs/</span><span class="si">{id}</span><span class="s2">/endpoint_configuration"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ReservedDomainsClient"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient">[docs]</a><span class="k">class</span> <span class="nc">ReservedDomainsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="ReservedDomainsClient.create"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">region</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">http_endpoint_configuration_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">https_endpoint_configuration_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">certificate_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">certificate_management_policy</span><span class="p">:</span> <span class="n">ReservedDomainCertPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">ReservedDomain</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new reserved domain.</span>
|
|
|
|
<span class="sd"> :param name: the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.</span>
|
|
<span class="sd"> :param region: reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</span>
|
|
<span class="sd"> :param description: human-readable description of what this reserved domain will be used for</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param http_endpoint_configuration_id: ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</span>
|
|
<span class="sd"> :param https_endpoint_configuration_id: ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</span>
|
|
<span class="sd"> :param certificate_id: ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.</span>
|
|
<span class="sd"> :param certificate_management_policy: configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_domains"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
|
|
<span class="n">region</span><span class="o">=</span><span class="n">region</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">http_endpoint_configuration_id</span><span class="o">=</span><span class="n">http_endpoint_configuration_id</span><span class="p">,</span>
|
|
<span class="n">https_endpoint_configuration_id</span><span class="o">=</span><span class="n">https_endpoint_configuration_id</span><span class="p">,</span>
|
|
<span class="n">certificate_id</span><span class="o">=</span><span class="n">certificate_id</span><span class="p">,</span>
|
|
<span class="n">certificate_management_policy</span><span class="o">=</span><span class="n">certificate_management_policy</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">ReservedDomain</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="ReservedDomainsClient.delete"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete a reserved domain.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_domains/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="ReservedDomainsClient.get"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">ReservedDomain</span><span class="p">:</span>
|
|
<span class="sd">"""Get the details of a reserved domain.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_domains/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">ReservedDomain</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="ReservedDomainsClient.list"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">ReservedDomainList</span><span class="p">:</span>
|
|
<span class="sd">"""List all reserved domains on this account.</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_domains"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">ReservedDomainList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="ReservedDomainsClient.update"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">http_endpoint_configuration_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">https_endpoint_configuration_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">certificate_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">certificate_management_policy</span><span class="p">:</span> <span class="n">ReservedDomainCertPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">ReservedDomain</span><span class="p">:</span>
|
|
<span class="sd">"""Update the attributes of a reserved domain.</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of what this reserved domain will be used for</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param http_endpoint_configuration_id: ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</span>
|
|
<span class="sd"> :param https_endpoint_configuration_id: ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</span>
|
|
<span class="sd"> :param certificate_id: ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.</span>
|
|
<span class="sd"> :param certificate_management_policy: configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_domains/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">http_endpoint_configuration_id</span><span class="o">=</span><span class="n">http_endpoint_configuration_id</span><span class="p">,</span>
|
|
<span class="n">https_endpoint_configuration_id</span><span class="o">=</span><span class="n">https_endpoint_configuration_id</span><span class="p">,</span>
|
|
<span class="n">certificate_id</span><span class="o">=</span><span class="n">certificate_id</span><span class="p">,</span>
|
|
<span class="n">certificate_management_policy</span><span class="o">=</span><span class="n">certificate_management_policy</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">ReservedDomain</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="ReservedDomainsClient.delete_certificate_management_policy"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.delete_certificate_management_policy">[docs]</a> <span class="k">def</span> <span class="nf">delete_certificate_management_policy</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Detach the certificate management policy attached to a reserved domain.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_domains/</span><span class="si">{id}</span><span class="s2">/certificate_management_policy"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="ReservedDomainsClient.delete_certificate"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.delete_certificate">[docs]</a> <span class="k">def</span> <span class="nf">delete_certificate</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Detach the certificate attached to a reserved domain.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-delete-certificate</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_domains/</span><span class="si">{id}</span><span class="s2">/certificate"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="ReservedDomainsClient.delete_http_endpoint_config"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.delete_http_endpoint_config">[docs]</a> <span class="k">def</span> <span class="nf">delete_http_endpoint_config</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Detach the http endpoint configuration attached to a reserved domain.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_domains/</span><span class="si">{id}</span><span class="s2">/http_endpoint_configuration"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="ReservedDomainsClient.delete_https_endpoint_config"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.delete_https_endpoint_config">[docs]</a> <span class="k">def</span> <span class="nf">delete_https_endpoint_config</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Detach the https endpoint configuration attached to a reserved domain.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/reserved_domains/</span><span class="si">{id}</span><span class="s2">/https_endpoint_configuration"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="SSHCertificateAuthoritiesClient"><a class="viewcode-back" href="../../ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient">[docs]</a><span class="k">class</span> <span class="nc">SSHCertificateAuthoritiesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="SSHCertificateAuthoritiesClient.create"><a class="viewcode-back" href="../../ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">private_key_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">elliptic_curve</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">key_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHCertificateAuthority</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new SSH Certificate Authority</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of this SSH Certificate Authority. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param private_key_type: the type of private key to generate. one of ``rsa``, ``ecdsa``, ``ed25519``</span>
|
|
<span class="sd"> :param elliptic_curve: the type of elliptic curve to use when creating an ECDSA key</span>
|
|
<span class="sd"> :param key_size: the key size to use when creating an RSA key. one of ``2048`` or ``4096``</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-certificate-authorities-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_certificate_authorities"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">private_key_type</span><span class="o">=</span><span class="n">private_key_type</span><span class="p">,</span>
|
|
<span class="n">elliptic_curve</span><span class="o">=</span><span class="n">elliptic_curve</span><span class="p">,</span>
|
|
<span class="n">key_size</span><span class="o">=</span><span class="n">key_size</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHCertificateAuthority</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="SSHCertificateAuthoritiesClient.delete"><a class="viewcode-back" href="../../ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an SSH Certificate Authority</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_certificate_authorities/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="SSHCertificateAuthoritiesClient.get"><a class="viewcode-back" href="../../ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHCertificateAuthority</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an SSH Certficate Authority</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-certificate-authorities-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_certificate_authorities/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">SSHCertificateAuthority</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="SSHCertificateAuthoritiesClient.list"><a class="viewcode-back" href="../../ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHCertificateAuthorityList</span><span class="p">:</span>
|
|
<span class="sd">"""List all SSH Certificate Authorities on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-certificate-authorities-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_certificate_authorities"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHCertificateAuthorityList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="SSHCertificateAuthoritiesClient.update"><a class="viewcode-back" href="../../ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHCertificateAuthority</span><span class="p">:</span>
|
|
<span class="sd">"""Update an SSH Certificate Authority</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of this SSH Certificate Authority. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-certificate-authorities-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_certificate_authorities/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHCertificateAuthority</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="SSHCredentialsClient"><a class="viewcode-back" href="../../ssh_credentials.html#ngrok.services.SSHCredentialsClient">[docs]</a><span class="k">class</span> <span class="nc">SSHCredentialsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="SSHCredentialsClient.create"><a class="viewcode-back" href="../../ssh_credentials.html#ngrok.services.SSHCredentialsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">public_key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="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">acl</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHCredential</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.</span>
|
|
<span class="sd"> :param public_key: the PEM-encoded public key of the SSH keypair that will be used to authenticate</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-credentials-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_credentials"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">acl</span><span class="o">=</span><span class="n">acl</span><span class="p">,</span>
|
|
<span class="n">public_key</span><span class="o">=</span><span class="n">public_key</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHCredential</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="SSHCredentialsClient.delete"><a class="viewcode-back" href="../../ssh_credentials.html#ngrok.services.SSHCredentialsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an ssh_credential by ID</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-credentials-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_credentials/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="SSHCredentialsClient.get"><a class="viewcode-back" href="../../ssh_credentials.html#ngrok.services.SSHCredentialsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHCredential</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an ssh_credential</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-credentials-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_credentials/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">SSHCredential</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="SSHCredentialsClient.list"><a class="viewcode-back" href="../../ssh_credentials.html#ngrok.services.SSHCredentialsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHCredentialList</span><span class="p">:</span>
|
|
<span class="sd">"""List all ssh credentials on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-credentials-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_credentials"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHCredentialList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="SSHCredentialsClient.update"><a class="viewcode-back" href="../../ssh_credentials.html#ngrok.services.SSHCredentialsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">acl</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHCredential</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of an ssh_credential by ID</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-credentials-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_credentials/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">acl</span><span class="o">=</span><span class="n">acl</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHCredential</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="SSHHostCertificatesClient"><a class="viewcode-back" href="../../ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient">[docs]</a><span class="k">class</span> <span class="nc">SSHHostCertificatesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="SSHHostCertificatesClient.create"><a class="viewcode-back" href="../../ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">ssh_certificate_authority_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">public_key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">principals</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<span class="n">valid_after</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">valid_until</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHHostCertificate</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new SSH Host Certificate</span>
|
|
|
|
<span class="sd"> :param ssh_certificate_authority_id: the ssh certificate authority that is used to sign this ssh host certificate</span>
|
|
<span class="sd"> :param public_key: a public key in OpenSSH Authorized Keys format that this certificate signs</span>
|
|
<span class="sd"> :param principals: the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.</span>
|
|
<span class="sd"> :param valid_after: The time when the host certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.</span>
|
|
<span class="sd"> :param valid_until: The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this ``valid_before``.</span>
|
|
<span class="sd"> :param description: human-readable description of this SSH Host Certificate. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-host-certificates-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_host_certificates"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">ssh_certificate_authority_id</span><span class="o">=</span><span class="n">ssh_certificate_authority_id</span><span class="p">,</span>
|
|
<span class="n">public_key</span><span class="o">=</span><span class="n">public_key</span><span class="p">,</span>
|
|
<span class="n">principals</span><span class="o">=</span><span class="n">principals</span><span class="p">,</span>
|
|
<span class="n">valid_after</span><span class="o">=</span><span class="n">valid_after</span><span class="p">,</span>
|
|
<span class="n">valid_until</span><span class="o">=</span><span class="n">valid_until</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHHostCertificate</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="SSHHostCertificatesClient.delete"><a class="viewcode-back" href="../../ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an SSH Host Certificate</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-host-certificates-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_host_certificates/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="SSHHostCertificatesClient.get"><a class="viewcode-back" href="../../ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHHostCertificate</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an SSH Host Certficate</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-host-certificates-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_host_certificates/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">SSHHostCertificate</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="SSHHostCertificatesClient.list"><a class="viewcode-back" href="../../ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHHostCertificateList</span><span class="p">:</span>
|
|
<span class="sd">"""List all SSH Host Certificates issued on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-host-certificates-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_host_certificates"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHHostCertificateList</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="SSHHostCertificatesClient.update"><a class="viewcode-back" href="../../ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHHostCertificate</span><span class="p">:</span>
|
|
<span class="sd">"""Update an SSH Host Certificate</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of this SSH Host Certificate. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-host-certificates-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_host_certificates/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHHostCertificate</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="SSHUserCertificatesClient"><a class="viewcode-back" href="../../ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient">[docs]</a><span class="k">class</span> <span class="nc">SSHUserCertificatesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="SSHUserCertificatesClient.create"><a class="viewcode-back" href="../../ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">ssh_certificate_authority_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">public_key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">principals</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<span class="n">critical_options</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{},</span>
|
|
<span class="n">extensions</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{},</span>
|
|
<span class="n">valid_after</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">valid_until</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHUserCertificate</span><span class="p">:</span>
|
|
<span class="sd">"""Create a new SSH User Certificate</span>
|
|
|
|
<span class="sd"> :param ssh_certificate_authority_id: the ssh certificate authority that is used to sign this ssh user certificate</span>
|
|
<span class="sd"> :param public_key: a public key in OpenSSH Authorized Keys format that this certificate signs</span>
|
|
<span class="sd"> :param principals: the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.</span>
|
|
<span class="sd"> :param critical_options: A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: ``force-command`` and ``source-address``. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details.</span>
|
|
<span class="sd"> :param extensions: A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: ``{"permit-pty": "", "permit-user-rc": ""}`` OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details.</span>
|
|
<span class="sd"> :param valid_after: The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.</span>
|
|
<span class="sd"> :param valid_until: The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this ``valid_before``.</span>
|
|
<span class="sd"> :param description: human-readable description of this SSH User Certificate. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-user-certificates-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_user_certificates"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">ssh_certificate_authority_id</span><span class="o">=</span><span class="n">ssh_certificate_authority_id</span><span class="p">,</span>
|
|
<span class="n">public_key</span><span class="o">=</span><span class="n">public_key</span><span class="p">,</span>
|
|
<span class="n">principals</span><span class="o">=</span><span class="n">principals</span><span class="p">,</span>
|
|
<span class="n">critical_options</span><span class="o">=</span><span class="n">critical_options</span><span class="p">,</span>
|
|
<span class="n">extensions</span><span class="o">=</span><span class="n">extensions</span><span class="p">,</span>
|
|
<span class="n">valid_after</span><span class="o">=</span><span class="n">valid_after</span><span class="p">,</span>
|
|
<span class="n">valid_until</span><span class="o">=</span><span class="n">valid_until</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHUserCertificate</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="SSHUserCertificatesClient.delete"><a class="viewcode-back" href="../../ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete an SSH User Certificate</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-user-certificates-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_user_certificates/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="SSHUserCertificatesClient.get"><a class="viewcode-back" href="../../ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHUserCertificate</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about an SSH User Certficate</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-user-certificates-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_user_certificates/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">SSHUserCertificate</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="SSHUserCertificatesClient.list"><a class="viewcode-back" href="../../ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHUserCertificateList</span><span class="p">:</span>
|
|
<span class="sd">"""List all SSH User Certificates issued on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-user-certificates-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_user_certificates"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHUserCertificateList</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="SSHUserCertificatesClient.update"><a class="viewcode-back" href="../../ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">SSHUserCertificate</span><span class="p">:</span>
|
|
<span class="sd">"""Update an SSH User Certificate</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of this SSH User Certificate. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-ssh-user-certificates-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/ssh_user_certificates/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">SSHUserCertificate</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="TLSCertificatesClient"><a class="viewcode-back" href="../../tls_certificates.html#ngrok.services.TLSCertificatesClient">[docs]</a><span class="k">class</span> <span class="nc">TLSCertificatesClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="TLSCertificatesClient.create"><a class="viewcode-back" href="../../tls_certificates.html#ngrok.services.TLSCertificatesClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">certificate_pem</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">private_key_pem</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="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="p">)</span> <span class="o">-></span> <span class="n">TLSCertificate</span><span class="p">:</span>
|
|
<span class="sd">"""Upload a new TLS certificate</span>
|
|
|
|
<span class="sd"> :param description: human-readable description of this TLS certificate. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</span>
|
|
<span class="sd"> :param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` <https://ngrok.com/docs/api#tls-certificates-pem>`_.</span>
|
|
<span class="sd"> :param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys` <https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tls-certificates-create</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tls_certificates"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="n">certificate_pem</span><span class="o">=</span><span class="n">certificate_pem</span><span class="p">,</span>
|
|
<span class="n">private_key_pem</span><span class="o">=</span><span class="n">private_key_pem</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">TLSCertificate</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="TLSCertificatesClient.delete"><a class="viewcode-back" href="../../tls_certificates.html#ngrok.services.TLSCertificatesClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Delete a TLS certificate</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tls-certificates-delete</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tls_certificates/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="TLSCertificatesClient.get"><a class="viewcode-back" href="../../tls_certificates.html#ngrok.services.TLSCertificatesClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">TLSCertificate</span><span class="p">:</span>
|
|
<span class="sd">"""Get detailed information about a TLS certificate</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tls-certificates-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tls_certificates/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">TLSCertificate</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="TLSCertificatesClient.list"><a class="viewcode-back" href="../../tls_certificates.html#ngrok.services.TLSCertificatesClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">TLSCertificateList</span><span class="p">:</span>
|
|
<span class="sd">"""List all TLS certificates on this account</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tls-certificates-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tls_certificates"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">TLSCertificateList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="TLSCertificatesClient.update"><a class="viewcode-back" href="../../tls_certificates.html#ngrok.services.TLSCertificatesClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">TLSCertificate</span><span class="p">:</span>
|
|
<span class="sd">"""Update attributes of a TLS Certificate by ID</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
<span class="sd"> :param description: human-readable description of this TLS certificate. optional, max 255 bytes.</span>
|
|
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tls-certificates-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tls_certificates/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
|
|
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">TLSCertificate</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="TunnelSessionsClient"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient">[docs]</a><span class="k">class</span> <span class="nc">TunnelSessionsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="TunnelSessionsClient.list"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">TunnelSessionList</span><span class="p">:</span>
|
|
<span class="sd">"""List all online tunnel sessions running on this account.</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tunnel_sessions"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">TunnelSessionList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="TunnelSessionsClient.get"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">TunnelSession</span><span class="p">:</span>
|
|
<span class="sd">"""Get the detailed status of a tunnel session by ID</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-get</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
|
|
<span class="k">return</span> <span class="n">TunnelSession</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="TunnelSessionsClient.restart"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.restart">[docs]</a> <span class="k">def</span> <span class="nf">restart</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-restart</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">/restart"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="TunnelSessionsClient.stop"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Issues a command instructing the ngrok agent that started this tunnel session to exit.</span>
|
|
|
|
<span class="sd"> :param id: a resource identifier</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-stop</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">/stop"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div>
|
|
|
|
<div class="viewcode-block" id="TunnelSessionsClient.update"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="sd">"""Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted</span>
|
|
|
|
<span class="sd"> :param id:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-update</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">/update"</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
|
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="TunnelsClient"><a class="viewcode-back" href="../../tunnels.html#ngrok.services.TunnelsClient">[docs]</a><span class="k">class</span> <span class="nc">TunnelsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
|
|
|
<div class="viewcode-block" id="TunnelsClient.list"><a class="viewcode-back" href="../../tunnels.html#ngrok.services.TunnelsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">TunnelList</span><span class="p">:</span>
|
|
<span class="sd">"""List all online tunnels currently running on the account.</span>
|
|
|
|
<span class="sd"> :param before_id:</span>
|
|
<span class="sd"> :param limit:</span>
|
|
|
|
<span class="sd"> https://ngrok.com/docs/api#api-tunnels-list</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="s2">"/tunnels"</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="n">path</span><span class="p">,</span>
|
|
<span class="nb">dict</span><span class="p">(</span>
|
|
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
|
|
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">TunnelList</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>
|
|
<footer>
|
|
|
|
<div class="related-pages">
|
|
|
|
|
|
</div>
|
|
|
|
<div class="related-information">
|
|
Copyright © 2021, ngrok Inc.
|
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
|
|
and
|
|
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
|
<a href="https://github.com/pradyunsg/furo">Furo theme</a>.
|
|
</div>
|
|
|
|
</footer>
|
|
</div>
|
|
<aside class="toc-drawer no-toc">
|
|
|
|
|
|
|
|
</aside>
|
|
</main>
|
|
</div>
|
|
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
|
<script src="../../_static/jquery.js"></script>
|
|
<script src="../../_static/underscore.js"></script>
|
|
<script src="../../_static/doctools.js"></script>
|
|
<script src="../../_static/scripts/main.js?digest=e931d09b2a40c1bb82b542effe772014573baf67"></script></body>
|
|
</html> |