ngrok/ngrok-api-typescript
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-typescript.git synced 2026-05-17 16:50:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
ngrok-api-typescript/docs/classes/client.Ngrok.html
T
ngrok release bot b781552831 Update generated files
2026-01-23 21:37:49 +00:00

887 lines
58 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Ngrok | @ngrok/ngrok-api</title>
<meta name="description" content="Documentation for @ngrok/ngrok-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@ngrok/ngrok-api</a>
</li>
<li>
<a href="../modules/client.html">client</a>
</li>
<li>
<a href="client.Ngrok.html">Ngrok</a>
</li>
</ul>
<h1>Class Ngrok</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Ngrok</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="client.Ngrok.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#abuseReports" class="tsd-kind-icon">abuse<wbr>Reports</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#agentIngresses" class="tsd-kind-icon">agent<wbr>Ingresses</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#applicationSessions" class="tsd-kind-icon">application<wbr>Sessions</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#applicationUsers" class="tsd-kind-icon">application<wbr>Users</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#backends" class="tsd-kind-icon">backends</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#botUsers" class="tsd-kind-icon">bot<wbr>Users</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#credentials" class="tsd-kind-icon">credentials</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#edgeModules" class="tsd-kind-icon">edge<wbr>Modules</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#edges" class="tsd-kind-icon">edges</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#endpoints" class="tsd-kind-icon">endpoints</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventDestinations" class="tsd-kind-icon">event<wbr>Destinations</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventSources" class="tsd-kind-icon">event<wbr>Sources</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventSubscriptions" class="tsd-kind-icon">event<wbr>Subscriptions</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipPolicyRules" class="tsd-kind-icon">ip<wbr>Policy<wbr>Rules</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#reservedAddrs" class="tsd-kind-icon">reserved<wbr>Addrs</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#reservedDomains" class="tsd-kind-icon">reserved<wbr>Domains</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#secrets" class="tsd-kind-icon">secrets</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#serviceUsers" class="tsd-kind-icon">service<wbr>Users</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#sshCertificateAuthorities" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authorities</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#sshCredentials" class="tsd-kind-icon">ssh<wbr>Credentials</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#sshHostCertificates" class="tsd-kind-icon">ssh<wbr>Host<wbr>Certificates</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#sshUserCertificates" class="tsd-kind-icon">ssh<wbr>User<wbr>Certificates</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#tlsCertificates" class="tsd-kind-icon">tls<wbr>Certificates</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#tunnelSessions" class="tsd-kind-icon">tunnel<wbr>Sessions</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#tunnels" class="tsd-kind-icon">tunnels</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#vaults" class="tsd-kind-icon">vaults</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Ngrok<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/client.NgrokConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NgrokConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client.Ngrok.html" class="tsd-signature-type" data-tsd-kind="Class">Ngrok</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L213">client.ts:213</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates an instance of the Ngrok HTTP API client</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/client.NgrokConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NgrokConfig</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="client.Ngrok.html" class="tsd-signature-type" data-tsd-kind="Class">Ngrok</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="abuseReports" class="tsd-anchor"></a>
<h3>abuse<wbr>Reports</h3>
<div class="tsd-signature tsd-kind-icon">abuse<wbr>Reports<span class="tsd-signature-symbol">:</span> <a href="services.AbuseReports.html" class="tsd-signature-type" data-tsd-kind="Class">AbuseReports</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L28">client.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Abuse Reports allow you to submit take-down requests for URLs hosted by
ngrok that violate ngrok&#39;s terms of service.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="agentIngresses" class="tsd-anchor"></a>
<h3>agent<wbr>Ingresses</h3>
<div class="tsd-signature tsd-kind-icon">agent<wbr>Ingresses<span class="tsd-signature-symbol">:</span> <a href="services.AgentIngresses.html" class="tsd-signature-type" data-tsd-kind="Class">AgentIngresses</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L29">client.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="apiKeys" class="tsd-anchor"></a>
<h3>api<wbr>Keys</h3>
<div class="tsd-signature tsd-kind-icon">api<wbr>Keys<span class="tsd-signature-symbol">:</span> <a href="services.APIKeys.html" class="tsd-signature-type" data-tsd-kind="Class">APIKeys</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L37">client.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok
API</a>. You may use the API itself
to provision and manage API Keys but you&#39;ll need to provision your first API
key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your
ngrok.com dashboard.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="applicationSessions" class="tsd-anchor"></a>
<h3>application<wbr>Sessions</h3>
<div class="tsd-signature tsd-kind-icon">application<wbr>Sessions<span class="tsd-signature-symbol">:</span> <a href="services.ApplicationSessions.html" class="tsd-signature-type" data-tsd-kind="Class">ApplicationSessions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L38">client.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="applicationUsers" class="tsd-anchor"></a>
<h3>application<wbr>Users</h3>
<div class="tsd-signature tsd-kind-icon">application<wbr>Users<span class="tsd-signature-symbol">:</span> <a href="services.ApplicationUsers.html" class="tsd-signature-type" data-tsd-kind="Class">ApplicationUsers</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L39">client.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="backends" class="tsd-anchor"></a>
<h3>backends</h3>
<div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>failoverBackends<span class="tsd-signature-symbol">: </span><a href="services.FailoverBackends.html" class="tsd-signature-type" data-tsd-kind="Class">FailoverBackends</a><span class="tsd-signature-symbol">; </span>httpResponseBackends<span class="tsd-signature-symbol">: </span><a href="services.HTTPResponseBackends.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPResponseBackends</a><span class="tsd-signature-symbol">; </span>staticBackends<span class="tsd-signature-symbol">: </span><a href="services.StaticBackends.html" class="tsd-signature-type" data-tsd-kind="Class">StaticBackends</a><span class="tsd-signature-symbol">; </span>tunnelGroupBackends<span class="tsd-signature-symbol">: </span><a href="services.TunnelGroupBackends.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelGroupBackends</a><span class="tsd-signature-symbol">; </span>weightedBackends<span class="tsd-signature-symbol">: </span><a href="services.WeightedBackends.html" class="tsd-signature-type" data-tsd-kind="Class">WeightedBackends</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L149">client.ts:149</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>failover<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.FailoverBackends.html" class="tsd-signature-type" data-tsd-kind="Class">FailoverBackends</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A Failover backend defines failover behavior within a list of referenced
backends. Traffic is sent to the first backend in the list. If that backend
is offline or no connection can be established, ngrok attempts to connect to
the next backend in the list until one is successful.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>http<wbr>Response<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.HTTPResponseBackends.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPResponseBackends</a></h5>
</li>
<li class="tsd-parameter">
<h5>static<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.StaticBackends.html" class="tsd-signature-type" data-tsd-kind="Class">StaticBackends</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A static backend sends traffic to a TCP address (hostname and port) that
is reachable on the public internet.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>tunnel<wbr>Group<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.TunnelGroupBackends.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelGroupBackends</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A Tunnel Group Backend balances traffic among all online tunnels that match
a label selector.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>weighted<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.WeightedBackends.html" class="tsd-signature-type" data-tsd-kind="Class">WeightedBackends</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A Weighted Backend balances traffic among the referenced backends. Traffic
is assigned proportionally to each based on its weight. The percentage of
traffic is calculated by dividing a backend&#39;s weight by the sum of all
weights.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="botUsers" class="tsd-anchor"></a>
<h3>bot<wbr>Users</h3>
<div class="tsd-signature tsd-kind-icon">bot<wbr>Users<span class="tsd-signature-symbol">:</span> <a href="services.BotUsers.html" class="tsd-signature-type" data-tsd-kind="Class">BotUsers</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L46">client.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="certificateAuthorities" class="tsd-anchor"></a>
<h3>certificate<wbr>Authorities</h3>
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="services.CertificateAuthorities.html" class="tsd-signature-type" data-tsd-kind="Class">CertificateAuthorities</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L54">client.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="credentials" class="tsd-anchor"></a>
<h3>credentials</h3>
<div class="tsd-signature tsd-kind-icon">credentials<span class="tsd-signature-symbol">:</span> <a href="services.Credentials.html" class="tsd-signature-type" data-tsd-kind="Class">Credentials</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L61">client.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>ngrok config add-authtoken</code> command or by specifying it in the <code>ngrok.yml</code>
configuration file with the <code>authtoken</code> property.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="edgeModules" class="tsd-anchor"></a>
<h3>edge<wbr>Modules</h3>
<div class="tsd-signature tsd-kind-icon">edge<wbr>Modules<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>edgeRouteBackendModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteBackendModule</a><span class="tsd-signature-symbol">; </span>edgeRouteCircuitBreakerModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCircuitBreakerModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCircuitBreakerModule</a><span class="tsd-signature-symbol">; </span>edgeRouteCompressionModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCompressionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCompressionModule</a><span class="tsd-signature-symbol">; </span>edgeRouteIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>edgeRouteOAuthModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOAuthModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOAuthModule</a><span class="tsd-signature-symbol">; </span>edgeRouteOidcModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOIDCModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOIDCModule</a><span class="tsd-signature-symbol">; </span>edgeRouteRequestHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteRequestHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteRequestHeadersModule</a><span class="tsd-signature-symbol">; </span>edgeRouteResponseHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteResponseHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteResponseHeadersModule</a><span class="tsd-signature-symbol">; </span>edgeRouteSamlModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteSAMLModule</a><span class="tsd-signature-symbol">; </span>edgeRouteTrafficPolicyModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteTrafficPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteTrafficPolicyModule</a><span class="tsd-signature-symbol">; </span>edgeRouteUserAgentFilterModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteUserAgentFilterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteUserAgentFilterModule</a><span class="tsd-signature-symbol">; </span>edgeRouteWebhookVerificationModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebhookVerificationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebhookVerificationModule</a><span class="tsd-signature-symbol">; </span>edgeRouteWebsocketTcpConverterModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebsocketTCPConverterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebsocketTCPConverterModule</a><span class="tsd-signature-symbol">; </span>httpsEdgeMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeMutualTLSModule</a><span class="tsd-signature-symbol">; </span>httpsEdgeTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeTLSTerminationModule</a><span class="tsd-signature-symbol">; </span>tcpEdgeBackendModule<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeBackendModule</a><span class="tsd-signature-symbol">; </span>tcpEdgeIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>tcpEdgeTrafficPolicyModule<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeTrafficPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeTrafficPolicyModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeBackendModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeBackendModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeMutualTLSModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeTLSTerminationModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeTrafficPolicyModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeTrafficPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeTrafficPolicyModule</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L182">client.ts:182</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Backend<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteBackendModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Circuit<wbr>Breaker<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCircuitBreakerModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCircuitBreakerModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Compression<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCompressionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCompressionModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>IpRestriction<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteIPRestrictionModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>RouteOAuth<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOAuthModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOAuthModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Oidc<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOIDCModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOIDCModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Request<wbr>Headers<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteRequestHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteRequestHeadersModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Response<wbr>Headers<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteResponseHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteResponseHeadersModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Saml<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteSAMLModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Traffic<wbr>Policy<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteTrafficPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteTrafficPolicyModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>User<wbr>Agent<wbr>Filter<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteUserAgentFilterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteUserAgentFilterModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Webhook<wbr>Verification<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebhookVerificationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebhookVerificationModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>edge<wbr>Route<wbr>Websocket<wbr>Tcp<wbr>Converter<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebsocketTCPConverterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebsocketTCPConverterModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>https<wbr>Edge<wbr>Mutual<wbr>Tls<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeMutualTLSModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>https<wbr>Edge<wbr>Tls<wbr>Termination<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeTLSTerminationModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>tcp<wbr>Edge<wbr>Backend<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeBackendModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>tcp<wbr>Edge<wbr>IpRestriction<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeIPRestrictionModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>tcp<wbr>Edge<wbr>Traffic<wbr>Policy<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeTrafficPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeTrafficPolicyModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>tls<wbr>Edge<wbr>Backend<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeBackendModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>tls<wbr>Edge<wbr>IpRestriction<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeIPRestrictionModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>tls<wbr>Edge<wbr>Mutual<wbr>Tls<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeMutualTLSModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>tls<wbr>Edge<wbr>Tls<wbr>Termination<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeTLSTerminationModule</a></h5>
</li>
<li class="tsd-parameter">
<h5>tls<wbr>Edge<wbr>Traffic<wbr>Policy<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeTrafficPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeTrafficPolicyModule</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="edges" class="tsd-anchor"></a>
<h3>edges</h3>
<div class="tsd-signature tsd-kind-icon">edges<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>edgesHttps<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPS</a><span class="tsd-signature-symbol">; </span>edgesHttpsRoutes<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPSRoutes.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPSRoutes</a><span class="tsd-signature-symbol">; </span>edgesTcp<span class="tsd-signature-symbol">: </span><a href="services.EdgesTCP.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTCP</a><span class="tsd-signature-symbol">; </span>edgesTls<span class="tsd-signature-symbol">: </span><a href="services.EdgesTLS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTLS</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L176">client.ts:176</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>edges<wbr>Https<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPS</a></h5>
</li>
<li class="tsd-parameter">
<h5>edges<wbr>Https<wbr>Routes<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPSRoutes.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPSRoutes</a></h5>
</li>
<li class="tsd-parameter">
<h5>edges<wbr>Tcp<span class="tsd-signature-symbol">: </span><a href="services.EdgesTCP.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTCP</a></h5>
</li>
<li class="tsd-parameter">
<h5>edges<wbr>Tls<span class="tsd-signature-symbol">: </span><a href="services.EdgesTLS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTLS</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="endpoints" class="tsd-anchor"></a>
<h3>endpoints</h3>
<div class="tsd-signature tsd-kind-icon">endpoints<span class="tsd-signature-symbol">:</span> <a href="services.Endpoints.html" class="tsd-signature-type" data-tsd-kind="Class">Endpoints</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L67">client.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="eventDestinations" class="tsd-anchor"></a>
<h3>event<wbr>Destinations</h3>
<div class="tsd-signature tsd-kind-icon">event<wbr>Destinations<span class="tsd-signature-symbol">:</span> <a href="services.EventDestinations.html" class="tsd-signature-type" data-tsd-kind="Class">EventDestinations</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L68">client.ts:68</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="eventSources" class="tsd-anchor"></a>
<h3>event<wbr>Sources</h3>
<div class="tsd-signature tsd-kind-icon">event<wbr>Sources<span class="tsd-signature-symbol">:</span> <a href="services.EventSources.html" class="tsd-signature-type" data-tsd-kind="Class">EventSources</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L70">client.ts:70</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="eventSubscriptions" class="tsd-anchor"></a>
<h3>event<wbr>Subscriptions</h3>
<div class="tsd-signature tsd-kind-icon">event<wbr>Subscriptions<span class="tsd-signature-symbol">:</span> <a href="services.EventSubscriptions.html" class="tsd-signature-type" data-tsd-kind="Class">EventSubscriptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L69">client.ts:69</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="ipPolicies" class="tsd-anchor"></a>
<h3>ip<wbr>Policies</h3>
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="services.IPPolicies.html" class="tsd-signature-type" data-tsd-kind="Class">IPPolicies</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L77">client.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="ipPolicyRules" class="tsd-anchor"></a>
<h3>ip<wbr>Policy<wbr>Rules</h3>
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Rules<span class="tsd-signature-symbol">:</span> <a href="services.IPPolicyRules.html" class="tsd-signature-type" data-tsd-kind="Class">IPPolicyRules</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L82">client.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
make up an IP Policy.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="ipRestrictions" class="tsd-anchor"></a>
<h3>ip<wbr>Restrictions</h3>
<div class="tsd-signature tsd-kind-icon">ip<wbr>Restrictions<span class="tsd-signature-symbol">:</span> <a href="services.IPRestrictions.html" class="tsd-signature-type" data-tsd-kind="Class">IPRestrictions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L91">client.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="reservedAddrs" class="tsd-anchor"></a>
<h3>reserved<wbr>Addrs</h3>
<div class="tsd-signature tsd-kind-icon">reserved<wbr>Addrs<span class="tsd-signature-symbol">:</span> <a href="services.ReservedAddrs.html" class="tsd-signature-type" data-tsd-kind="Class">ReservedAddrs</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L97">client.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="reservedDomains" class="tsd-anchor"></a>
<h3>reserved<wbr>Domains</h3>
<div class="tsd-signature tsd-kind-icon">reserved<wbr>Domains<span class="tsd-signature-symbol">:</span> <a href="services.ReservedDomains.html" class="tsd-signature-type" data-tsd-kind="Class">ReservedDomains</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L104">client.ts:104</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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&#39;s edge servers.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="secrets" class="tsd-anchor"></a>
<h3>secrets</h3>
<div class="tsd-signature tsd-kind-icon">secrets<span class="tsd-signature-symbol">:</span> <a href="services.Secrets.html" class="tsd-signature-type" data-tsd-kind="Class">Secrets</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L108">client.ts:108</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="serviceUsers" class="tsd-anchor"></a>
<h3>service<wbr>Users</h3>
<div class="tsd-signature tsd-kind-icon">service<wbr>Users<span class="tsd-signature-symbol">:</span> <a href="services.ServiceUsers.html" class="tsd-signature-type" data-tsd-kind="Class">ServiceUsers</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L109">client.ts:109</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="sshCertificateAuthorities" class="tsd-anchor"></a>
<h3>ssh<wbr>Certificate<wbr>Authorities</h3>
<div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="services.SSHCertificateAuthorities.html" class="tsd-signature-type" data-tsd-kind="Class">SSHCertificateAuthorities</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L114">client.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="sshCredentials" class="tsd-anchor"></a>
<h3>ssh<wbr>Credentials</h3>
<div class="tsd-signature tsd-kind-icon">ssh<wbr>Credentials<span class="tsd-signature-symbol">:</span> <a href="services.SSHCredentials.html" class="tsd-signature-type" data-tsd-kind="Class">SSHCredentials</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L119">client.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels
via the ngrok SSH tunnel gateway.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="sshHostCertificates" class="tsd-anchor"></a>
<h3>ssh<wbr>Host<wbr>Certificates</h3>
<div class="tsd-signature tsd-kind-icon">ssh<wbr>Host<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.SSHHostCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">SSHHostCertificates</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L125">client.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="sshUserCertificates" class="tsd-anchor"></a>
<h3>ssh<wbr>User<wbr>Certificates</h3>
<div class="tsd-signature tsd-kind-icon">ssh<wbr>User<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.SSHUserCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">SSHUserCertificates</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L131">client.ts:131</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="tlsCertificates" class="tsd-anchor"></a>
<h3>tls<wbr>Certificates</h3>
<div class="tsd-signature tsd-kind-icon">tls<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.TLSCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">TLSCertificates</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L139">client.ts:139</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="tunnelSessions" class="tsd-anchor"></a>
<h3>tunnel<wbr>Sessions</h3>
<div class="tsd-signature tsd-kind-icon">tunnel<wbr>Sessions<span class="tsd-signature-symbol">:</span> <a href="services.TunnelSessions.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelSessions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L45">client.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="tunnels" class="tsd-anchor"></a>
<h3>tunnels</h3>
<div class="tsd-signature tsd-kind-icon">tunnels<span class="tsd-signature-symbol">:</span> <a href="services.Tunnels.html" class="tsd-signature-type" data-tsd-kind="Class">Tunnels</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L144">client.ts:144</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Tunnels provide endpoints to access services exposed by a running ngrok
agent tunnel session or an SSH reverse tunnel session.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="vaults" class="tsd-anchor"></a>
<h3>vaults</h3>
<div class="tsd-signature tsd-kind-icon">vaults<span class="tsd-signature-symbol">:</span> <a href="services.Vaults.html" class="tsd-signature-type" data-tsd-kind="Class">Vaults</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/client.ts#L148">client.ts:148</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/client.html">client</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/datatypes.html">datatypes</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/services.html">services</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="client.Ngrok.html" class="tsd-kind-icon">Ngrok</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="client.Ngrok.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#abuseReports" class="tsd-kind-icon">abuse<wbr>Reports</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#agentIngresses" class="tsd-kind-icon">agent<wbr>Ingresses</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#applicationSessions" class="tsd-kind-icon">application<wbr>Sessions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#applicationUsers" class="tsd-kind-icon">application<wbr>Users</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#backends" class="tsd-kind-icon">backends</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#botUsers" class="tsd-kind-icon">bot<wbr>Users</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#credentials" class="tsd-kind-icon">credentials</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#edgeModules" class="tsd-kind-icon">edge<wbr>Modules</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#edges" class="tsd-kind-icon">edges</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#endpoints" class="tsd-kind-icon">endpoints</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#eventDestinations" class="tsd-kind-icon">event<wbr>Destinations</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#eventSources" class="tsd-kind-icon">event<wbr>Sources</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#eventSubscriptions" class="tsd-kind-icon">event<wbr>Subscriptions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#ipPolicyRules" class="tsd-kind-icon">ip<wbr>Policy<wbr>Rules</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#reservedAddrs" class="tsd-kind-icon">reserved<wbr>Addrs</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#reservedDomains" class="tsd-kind-icon">reserved<wbr>Domains</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#secrets" class="tsd-kind-icon">secrets</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#serviceUsers" class="tsd-kind-icon">service<wbr>Users</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#sshCertificateAuthorities" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authorities</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#sshCredentials" class="tsd-kind-icon">ssh<wbr>Credentials</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#sshHostCertificates" class="tsd-kind-icon">ssh<wbr>Host<wbr>Certificates</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#sshUserCertificates" class="tsd-kind-icon">ssh<wbr>User<wbr>Certificates</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#tlsCertificates" class="tsd-kind-icon">tls<wbr>Certificates</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#tunnelSessions" class="tsd-kind-icon">tunnel<wbr>Sessions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#tunnels" class="tsd-kind-icon">tunnels</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="client.Ngrok.html#vaults" class="tsd-kind-icon">vaults</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/client.NgrokConfig.html" class="tsd-kind-icon">Ngrok<wbr>Config</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink