mirror of
https://github.com/ngrok/ngrok-api-typescript.git
synced 2026-05-17 16:50:35 +00:00
ngrok release bot
314 lines
14 KiB
HTML
314 lines
14 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>HTTPSEdge | @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/datatypes.html">datatypes</a>
|
|
</li>
|
|
<li>
|
|
<a href="datatypes.HTTPSEdge.html">HTTPSEdge</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface HTTPSEdge</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">HTTPSEdge</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>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#description" class="tsd-kind-icon">description</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#hostports" class="tsd-kind-icon">hostports</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#id" class="tsd-kind-icon">id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#routes" class="tsd-kind-icon">routes</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</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-interface">
|
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
<h3>created<wbr>At</h3>
|
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1210">datatypes.ts:1210</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>timestamp when the edge configuration was created, RFC 3339 format</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="description" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1206">datatypes.ts:1206</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="hostports" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
|
|
<div class="tsd-signature tsd-kind-icon">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/datatypes.ts#L1214">datatypes.ts:1214</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>hostports served by this edge</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="id" class="tsd-anchor"></a>
|
|
<h3>id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1204">datatypes.ts:1204</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="metadata" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1208">datatypes.ts:1208</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="mutualTls" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual<wbr>Tls</h3>
|
|
<div class="tsd-signature tsd-kind-icon">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLS</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1216">datatypes.ts:1216</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>edge modules</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="routes" class="tsd-anchor"></a>
|
|
<h3>routes</h3>
|
|
<div class="tsd-signature tsd-kind-icon">routes<span class="tsd-signature-symbol">:</span> <a href="datatypes.HTTPSEdgeRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPSEdgeRoute</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/datatypes.ts#L1219">datatypes.ts:1219</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>routes</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="tlsTermination" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
|
|
<div class="tsd-signature tsd-kind-icon">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1217">datatypes.ts:1217</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="uri" class="tsd-anchor"></a>
|
|
<h3>uri</h3>
|
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1212">datatypes.ts:1212</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>URI of the edge API resource</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=" tsd-kind-module">
|
|
<a href="../modules/client.html">client</a>
|
|
</li>
|
|
<li class="current 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-interface tsd-parent-kind-module">
|
|
<a href="datatypes.HTTPSEdge.html" class="tsd-kind-icon">HTTPSEdge</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdge.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdge.html#description" class="tsd-kind-icon">description</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdge.html#hostports" class="tsd-kind-icon">hostports</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdge.html#id" class="tsd-kind-icon">id</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdge.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdge.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdge.html#routes" class="tsd-kind-icon">routes</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdge.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdge.html#uri" class="tsd-kind-icon">uri</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</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-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</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> |