mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-05-17 16:50:36 +00:00
ngrok release bot
722 lines
58 KiB
HTML
722 lines
58 KiB
HTML
<!doctype html>
|
||
<html class="no-js" lang="en">
|
||
<head><meta charset="utf-8"/>
|
||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Datatypes" href="datatypes.html" /><link rel="prev" title="ngrok-api" href="index.html" />
|
||
|
||
<!-- Generated with Sphinx 6.1.3 and Furo 2022.12.07 -->
|
||
<title>Client - ngrok-api documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||
|
||
|
||
|
||
|
||
<style>
|
||
body {
|
||
--color-code-background: #f8f8f8;
|
||
--color-code-foreground: black;
|
||
|
||
}
|
||
@media not print {
|
||
body[data-theme="dark"] {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
@media (prefers-color-scheme: dark) {
|
||
body:not([data-theme="light"]) {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
}
|
||
}
|
||
</style></head>
|
||
<body>
|
||
|
||
<script>
|
||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||
</script>
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||
<title>Light mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||
<circle cx="12" cy="12" r="5"></circle>
|
||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||
<title>Dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||
<title>Auto light/dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||
<circle cx="12" cy="12" r="9" />
|
||
<path d="M13 12h5" />
|
||
<path d="M13 15h4" />
|
||
<path d="M13 18h1" />
|
||
<path d="M13 9h4" />
|
||
<path d="M13 6h1" />
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
<label class="overlay sidebar-overlay" for="__navigation">
|
||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||
</label>
|
||
<label class="overlay toc-overlay" for="__toc">
|
||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||
</label>
|
||
|
||
|
||
|
||
<div class="page">
|
||
<header class="mobile-header">
|
||
<div class="header-left">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<div class="header-center">
|
||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||
</div>
|
||
<div class="header-right">
|
||
<div class="theme-toggle-container theme-toggle-header">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
</header>
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||
|
||
|
||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||
|
||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form>
|
||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Client</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Services</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="static_backends.html">Static Backends</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="bot_users.html">Bot Users</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_traffic_policy_module.html">HTTPS Edge Route Traffic Policy Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_traffic_policy_module.html">TCP Edge Traffic Policy Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_traffic_policy_module.html">TLS Edge Traffic Policy Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="secrets.html">Secrets</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ssh_user_certificates.html">SSH User Certificates</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vaults.html">Vaults</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<div class="main">
|
||
<div class="content">
|
||
<div class="article-container">
|
||
<a href="#" class="back-to-top muted-link">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||
</svg>
|
||
<span>Back to top</span>
|
||
</a>
|
||
<div class="content-icon-container">
|
||
|
||
<div class="theme-toggle-container theme-toggle-content">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<article role="main">
|
||
<section id="client">
|
||
<h1>Client<a class="headerlink" href="#client" title="Permalink to this heading">#</a></h1>
|
||
<p><a class="reference internal" href="#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">Client</span></code></a> is the root object of the <cite>ngrok-api</cite> library. Construct
|
||
a Client with an API Key. Then you can access API Services as properties of the
|
||
Client object:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">ngrok</span>
|
||
|
||
<span class="c1"># construct the api client</span>
|
||
<span class="n">client</span> <span class="o">=</span> <span class="n">ngrok</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="s2">"<API KEY>"</span><span class="p">)</span>
|
||
|
||
<span class="c1"># list all ip policies</span>
|
||
<span class="k">for</span> <span class="n">policy</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">ip_policies</span><span class="o">.</span><span class="n">list</span><span class="p">():</span>
|
||
<span class="nb">print</span><span class="p">(</span><span class="n">policy</span><span class="p">)</span>
|
||
|
||
<span class="c1"># create an ngrok agent authtoken</span>
|
||
<span class="n">cred</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">credentials</span><span class="o">.</span><span class="n">create</span><span class="p">()</span>
|
||
<span class="nb">print</span><span class="p">(</span><span class="n">cred</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<span class="target" id="module-ngrok"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="ngrok.Client">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.</span></span><span class="sig-name descname"><span class="pre">Client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'https://api.ngrok.com'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/client.html#Client"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.Client" title="Permalink to this definition">#</a></dt>
|
||
<dd><dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.abuse_reports">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">abuse_reports</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="abuse_reports.html#ngrok.services.AbuseReportsClient" title="ngrok.services.AbuseReportsClient"><span class="pre">AbuseReportsClient</span></a></em><a class="headerlink" href="#ngrok.Client.abuse_reports" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Abuse Reports allow you to submit take-down requests for URLs hosted by
|
||
ngrok that violate ngrok’s terms of service.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="abuse_reports.html#ngrok.services.AbuseReportsClient" title="ngrok.services.AbuseReportsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbuseReportsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.agent_ingresses">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">agent_ingresses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="agent_ingresses.html#ngrok.services.AgentIngressesClient" title="ngrok.services.AgentIngressesClient"><span class="pre">AgentIngressesClient</span></a></em><a class="headerlink" href="#ngrok.Client.agent_ingresses" title="Permalink to this definition">#</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="agent_ingresses.html#ngrok.services.AgentIngressesClient" title="ngrok.services.AgentIngressesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">AgentIngressesClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.api_keys">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">api_keys</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="api_keys.html#ngrok.services.APIKeysClient" title="ngrok.services.APIKeysClient"><span class="pre">APIKeysClient</span></a></em><a class="headerlink" href="#ngrok.Client.api_keys" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>API Keys are used to authenticate to the <a class="reference external" href="https://ngrok.com/docs/api#authentication">ngrok
|
||
API</a>. You may use the API itself
|
||
to provision and manage API Keys but you’ll need to provision your first API
|
||
key from the <a class="reference external" href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your
|
||
ngrok.com dashboard.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="api_keys.html#ngrok.services.APIKeysClient" title="ngrok.services.APIKeysClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKeysClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.application_sessions">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">application_sessions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="application_sessions.html#ngrok.services.ApplicationSessionsClient" title="ngrok.services.ApplicationSessionsClient"><span class="pre">ApplicationSessionsClient</span></a></em><a class="headerlink" href="#ngrok.Client.application_sessions" title="Permalink to this definition">#</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="application_sessions.html#ngrok.services.ApplicationSessionsClient" title="ngrok.services.ApplicationSessionsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationSessionsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.application_users">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">application_users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="application_users.html#ngrok.services.ApplicationUsersClient" title="ngrok.services.ApplicationUsersClient"><span class="pre">ApplicationUsersClient</span></a></em><a class="headerlink" href="#ngrok.Client.application_users" title="Permalink to this definition">#</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="application_users.html#ngrok.services.ApplicationUsersClient" title="ngrok.services.ApplicationUsersClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationUsersClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.backends">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">backends</span></span><a class="headerlink" href="#ngrok.Client.backends" title="Permalink to this definition">#</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.bot_users">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bot_users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient" title="ngrok.services.BotUsersClient"><span class="pre">BotUsersClient</span></a></em><a class="headerlink" href="#ngrok.Client.bot_users" title="Permalink to this definition">#</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="bot_users.html#ngrok.services.BotUsersClient" title="ngrok.services.BotUsersClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">BotUsersClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.certificate_authorities">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">certificate_authorities</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient" title="ngrok.services.CertificateAuthoritiesClient"><span class="pre">CertificateAuthoritiesClient</span></a></em><a class="headerlink" href="#ngrok.Client.certificate_authorities" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Certificate Authorities are x509 certificates that are used to sign other
|
||
x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
||
to verify that the TLS certificate presented by a client has been signed by
|
||
this CA. Certificate Authorities are used only for mTLS validation only and
|
||
thus a private key is not included in the resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient" title="ngrok.services.CertificateAuthoritiesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthoritiesClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.credentials">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="credentials.html#ngrok.services.CredentialsClient" title="ngrok.services.CredentialsClient"><span class="pre">CredentialsClient</span></a></em><a class="headerlink" href="#ngrok.Client.credentials" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
||
agent to connect the ngrok service as your account. They are installed with
|
||
the <code class="docutils literal notranslate"><span class="pre">ngrok</span> <span class="pre">config</span> <span class="pre">add-authtoken</span></code> command or by specifying it in the <code class="docutils literal notranslate"><span class="pre">ngrok.yml</span></code>
|
||
configuration file with the <code class="docutils literal notranslate"><span class="pre">authtoken</span></code> property.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="credentials.html#ngrok.services.CredentialsClient" title="ngrok.services.CredentialsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.edge_modules">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">edge_modules</span></span><a class="headerlink" href="#ngrok.Client.edge_modules" title="Permalink to this definition">#</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.edges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">edges</span></span><a class="headerlink" href="#ngrok.Client.edges" title="Permalink to this definition">#</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.endpoints">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">endpoints</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient" title="ngrok.services.EndpointsClient"><span class="pre">EndpointsClient</span></a></em><a class="headerlink" href="#ngrok.Client.endpoints" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Endpoints provides an API for querying the endpoint objects
|
||
which define what tunnel or edge is used to serve a hostport.
|
||
Only active endpoints associated with a tunnel or backend are returned.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient" title="ngrok.services.EndpointsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.event_destinations">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">event_destinations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="event_destinations.html#ngrok.services.EventDestinationsClient" title="ngrok.services.EventDestinationsClient"><span class="pre">EventDestinationsClient</span></a></em><a class="headerlink" href="#ngrok.Client.event_destinations" title="Permalink to this definition">#</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="event_destinations.html#ngrok.services.EventDestinationsClient" title="ngrok.services.EventDestinationsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestinationsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.event_sources">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">event_sources</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="event_sources.html#ngrok.services.EventSourcesClient" title="ngrok.services.EventSourcesClient"><span class="pre">EventSourcesClient</span></a></em><a class="headerlink" href="#ngrok.Client.event_sources" title="Permalink to this definition">#</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="event_sources.html#ngrok.services.EventSourcesClient" title="ngrok.services.EventSourcesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSourcesClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.event_subscriptions">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">event_subscriptions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="event_subscriptions.html#ngrok.services.EventSubscriptionsClient" title="ngrok.services.EventSubscriptionsClient"><span class="pre">EventSubscriptionsClient</span></a></em><a class="headerlink" href="#ngrok.Client.event_subscriptions" title="Permalink to this definition">#</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="event_subscriptions.html#ngrok.services.EventSubscriptionsClient" title="ngrok.services.EventSubscriptionsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSubscriptionsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.ip_policies">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ip_policies</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ip_policies.html#ngrok.services.IPPoliciesClient" title="ngrok.services.IPPoliciesClient"><span class="pre">IPPoliciesClient</span></a></em><a class="headerlink" href="#ngrok.Client.ip_policies" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>IP Policies are reusable groups of CIDR ranges with an <code class="docutils literal notranslate"><span class="pre">allow</span></code> or <code class="docutils literal notranslate"><span class="pre">deny</span></code>
|
||
action. They can be attached to endpoints via the Endpoint Configuration IP
|
||
Policy module. They can also be used with IP Restrictions to control source
|
||
IP ranges that can start tunnel sessions and connect to the API and dashboard.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="ip_policies.html#ngrok.services.IPPoliciesClient" title="ngrok.services.IPPoliciesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPoliciesClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.ip_policy_rules">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ip_policy_rules</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ip_policy_rules.html#ngrok.services.IPPolicyRulesClient" title="ngrok.services.IPPolicyRulesClient"><span class="pre">IPPolicyRulesClient</span></a></em><a class="headerlink" href="#ngrok.Client.ip_policy_rules" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
|
||
make up an IP Policy.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="ip_policy_rules.html#ngrok.services.IPPolicyRulesClient" title="ngrok.services.IPPolicyRulesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRulesClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.ip_restrictions">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ip_restrictions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ip_restrictions.html#ngrok.services.IPRestrictionsClient" title="ngrok.services.IPRestrictionsClient"><span class="pre">IPRestrictionsClient</span></a></em><a class="headerlink" href="#ngrok.Client.ip_restrictions" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>An IP restriction is a restriction placed on the CIDRs that are allowed to
|
||
initiate traffic to a specific aspect of your ngrok account. An IP
|
||
restriction has a type which defines the ingress it applies to. IP
|
||
restrictions can be used to enforce the source IPs that can make API
|
||
requests, log in to the dashboard, start ngrok agents, and connect to your
|
||
public-facing endpoints.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="ip_restrictions.html#ngrok.services.IPRestrictionsClient" title="ngrok.services.IPRestrictionsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestrictionsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.reserved_addrs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reserved_addrs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="reserved_addrs.html#ngrok.services.ReservedAddrsClient" title="ngrok.services.ReservedAddrsClient"><span class="pre">ReservedAddrsClient</span></a></em><a class="headerlink" href="#ngrok.Client.reserved_addrs" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Reserved Addresses are TCP addresses that can be used to listen for traffic.
|
||
TCP address hostnames and ports are assigned by ngrok, they cannot be
|
||
chosen.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="reserved_addrs.html#ngrok.services.ReservedAddrsClient" title="ngrok.services.ReservedAddrsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddrsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.reserved_domains">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reserved_domains</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="reserved_domains.html#ngrok.services.ReservedDomainsClient" title="ngrok.services.ReservedDomainsClient"><span class="pre">ReservedDomainsClient</span></a></em><a class="headerlink" href="#ngrok.Client.reserved_domains" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Reserved Domains are hostnames that you can listen for traffic on. Domains
|
||
can be used to listen for http, https or tls traffic. You may use a domain
|
||
that you own by creating a CNAME record specified in the returned resource.
|
||
This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="reserved_domains.html#ngrok.services.ReservedDomainsClient" title="ngrok.services.ReservedDomainsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.secrets">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">secrets</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient" title="ngrok.services.SecretsClient"><span class="pre">SecretsClient</span></a></em><a class="headerlink" href="#ngrok.Client.secrets" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="secrets.html#ngrok.services.SecretsClient" title="ngrok.services.SecretsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SecretsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.ssh_certificate_authorities">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ssh_certificate_authorities</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient" title="ngrok.services.SSHCertificateAuthoritiesClient"><span class="pre">SSHCertificateAuthoritiesClient</span></a></em><a class="headerlink" href="#ngrok.Client.ssh_certificate_authorities" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
||
key that can be used to sign other SSH host and user certificates.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient" title="ngrok.services.SSHCertificateAuthoritiesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthoritiesClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.ssh_credentials">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ssh_credentials</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ssh_credentials.html#ngrok.services.SSHCredentialsClient" title="ngrok.services.SSHCredentialsClient"><span class="pre">SSHCredentialsClient</span></a></em><a class="headerlink" href="#ngrok.Client.ssh_credentials" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>SSH Credentials are SSH public keys that can be used to start SSH tunnels
|
||
via the ngrok SSH tunnel gateway.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="ssh_credentials.html#ngrok.services.SSHCredentialsClient" title="ngrok.services.SSHCredentialsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredentialsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.ssh_host_certificates">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ssh_host_certificates</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient" title="ngrok.services.SSHHostCertificatesClient"><span class="pre">SSHHostCertificatesClient</span></a></em><a class="headerlink" href="#ngrok.Client.ssh_host_certificates" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>SSH Host Certificates along with the corresponding private key allows an SSH
|
||
server to assert its authenticity to connecting SSH clients who trust the
|
||
SSH Certificate Authority that was used to sign the certificate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="ssh_host_certificates.html#ngrok.services.SSHHostCertificatesClient" title="ngrok.services.SSHHostCertificatesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificatesClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.ssh_user_certificates">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ssh_user_certificates</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient" title="ngrok.services.SSHUserCertificatesClient"><span class="pre">SSHUserCertificatesClient</span></a></em><a class="headerlink" href="#ngrok.Client.ssh_user_certificates" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>SSH User Certificates are presented by SSH clients when connecting to an SSH
|
||
server to authenticate their connection. The SSH server must trust the SSH
|
||
Certificate Authority used to sign the certificate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="ssh_user_certificates.html#ngrok.services.SSHUserCertificatesClient" title="ngrok.services.SSHUserCertificatesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificatesClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.tls_certificates">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tls_certificates</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="tls_certificates.html#ngrok.services.TLSCertificatesClient" title="ngrok.services.TLSCertificatesClient"><span class="pre">TLSCertificatesClient</span></a></em><a class="headerlink" href="#ngrok.Client.tls_certificates" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>TLS Certificates are pairs of x509 certificates and their matching private
|
||
key that can be used to terminate TLS traffic. TLS certificates are unused
|
||
until they are attached to a Domain. TLS Certificates may also be
|
||
provisioned by ngrok automatically for domains on which you have enabled
|
||
automated certificate provisioning.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="tls_certificates.html#ngrok.services.TLSCertificatesClient" title="ngrok.services.TLSCertificatesClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificatesClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.tunnel_sessions">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tunnel_sessions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="tunnel_sessions.html#ngrok.services.TunnelSessionsClient" title="ngrok.services.TunnelSessionsClient"><span class="pre">TunnelSessionsClient</span></a></em><a class="headerlink" href="#ngrok.Client.tunnel_sessions" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
|
||
sessions that are running and connected to the ngrok service. Each tunnel
|
||
session can include one or more Tunnels.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="tunnel_sessions.html#ngrok.services.TunnelSessionsClient" title="ngrok.services.TunnelSessionsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelSessionsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.tunnels">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tunnels</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="tunnels.html#ngrok.services.TunnelsClient" title="ngrok.services.TunnelsClient"><span class="pre">TunnelsClient</span></a></em><a class="headerlink" href="#ngrok.Client.tunnels" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Tunnels provide endpoints to access services exposed by a running ngrok
|
||
agent tunnel session or an SSH reverse tunnel session.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="tunnels.html#ngrok.services.TunnelsClient" title="ngrok.services.TunnelsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ngrok.Client.vaults">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">vaults</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient" title="ngrok.services.VaultsClient"><span class="pre">VaultsClient</span></a></em><a class="headerlink" href="#ngrok.Client.vaults" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="vaults.html#ngrok.services.VaultsClient" title="ngrok.services.VaultsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">VaultsClient</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
</article>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
<a class="next-page" href="datatypes.html">
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Next</span>
|
||
</div>
|
||
<div class="title">Datatypes</div>
|
||
</div>
|
||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||
</a>
|
||
<a class="prev-page" href="index.html">
|
||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Previous</span>
|
||
</div>
|
||
|
||
<div class="title">Home</div>
|
||
|
||
</div>
|
||
</a>
|
||
</div>
|
||
<div class="bottom-of-page">
|
||
<div class="left-details">
|
||
<div class="copyright">
|
||
Copyright © 1980, ngrok Inc.
|
||
</div>
|
||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||
|
||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||
|
||
</div>
|
||
<div class="right-details">
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer">
|
||
|
||
|
||
<div class="toc-sticky toc-scroll">
|
||
<div class="toc-title-container">
|
||
<span class="toc-title">
|
||
On this page
|
||
</span>
|
||
</div>
|
||
<div class="toc-tree-container">
|
||
<div class="toc-tree">
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Client</a><ul>
|
||
<li><a class="reference internal" href="#ngrok.Client"><code class="docutils literal notranslate"><span class="pre">Client</span></code></a><ul>
|
||
<li><a class="reference internal" href="#ngrok.Client.abuse_reports"><code class="docutils literal notranslate"><span class="pre">Client.abuse_reports</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.agent_ingresses"><code class="docutils literal notranslate"><span class="pre">Client.agent_ingresses</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.api_keys"><code class="docutils literal notranslate"><span class="pre">Client.api_keys</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.application_sessions"><code class="docutils literal notranslate"><span class="pre">Client.application_sessions</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.application_users"><code class="docutils literal notranslate"><span class="pre">Client.application_users</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.backends"><code class="docutils literal notranslate"><span class="pre">Client.backends</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.bot_users"><code class="docutils literal notranslate"><span class="pre">Client.bot_users</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.certificate_authorities"><code class="docutils literal notranslate"><span class="pre">Client.certificate_authorities</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.credentials"><code class="docutils literal notranslate"><span class="pre">Client.credentials</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.edge_modules"><code class="docutils literal notranslate"><span class="pre">Client.edge_modules</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.edges"><code class="docutils literal notranslate"><span class="pre">Client.edges</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.endpoints"><code class="docutils literal notranslate"><span class="pre">Client.endpoints</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.event_destinations"><code class="docutils literal notranslate"><span class="pre">Client.event_destinations</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.event_sources"><code class="docutils literal notranslate"><span class="pre">Client.event_sources</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.event_subscriptions"><code class="docutils literal notranslate"><span class="pre">Client.event_subscriptions</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.ip_policies"><code class="docutils literal notranslate"><span class="pre">Client.ip_policies</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.ip_policy_rules"><code class="docutils literal notranslate"><span class="pre">Client.ip_policy_rules</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.ip_restrictions"><code class="docutils literal notranslate"><span class="pre">Client.ip_restrictions</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.reserved_addrs"><code class="docutils literal notranslate"><span class="pre">Client.reserved_addrs</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.reserved_domains"><code class="docutils literal notranslate"><span class="pre">Client.reserved_domains</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.secrets"><code class="docutils literal notranslate"><span class="pre">Client.secrets</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.ssh_certificate_authorities"><code class="docutils literal notranslate"><span class="pre">Client.ssh_certificate_authorities</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.ssh_credentials"><code class="docutils literal notranslate"><span class="pre">Client.ssh_credentials</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.ssh_host_certificates"><code class="docutils literal notranslate"><span class="pre">Client.ssh_host_certificates</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.ssh_user_certificates"><code class="docutils literal notranslate"><span class="pre">Client.ssh_user_certificates</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.tls_certificates"><code class="docutils literal notranslate"><span class="pre">Client.tls_certificates</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.tunnel_sessions"><code class="docutils literal notranslate"><span class="pre">Client.tunnel_sessions</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.tunnels"><code class="docutils literal notranslate"><span class="pre">Client.tunnels</span></code></a></li>
|
||
<li><a class="reference internal" href="#ngrok.Client.vaults"><code class="docutils literal notranslate"><span class="pre">Client.vaults</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</aside>
|
||
</div>
|
||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/sphinx_highlight.js"></script>
|
||
<script src="_static/scripts/furo.js"></script>
|
||
</body>
|
||
</html> |