mirror of
https://github.com/ngrok/ngrok-api-typescript.git
synced 2026-05-17 16:50:35 +00:00
ngrok release bot
542 lines
28 KiB
HTML
542 lines
28 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>HTTPSEdgeRoute | @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.HTTPSEdgeRoute.html">HTTPSEdgeRoute</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface HTTPSEdgeRoute</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">HTTPSEdgeRoute</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.HTTPSEdgeRoute.html#backend" class="tsd-kind-icon">backend</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#compression" class="tsd-kind-icon">compression</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#description" class="tsd-kind-icon">description</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#id" class="tsd-kind-icon">id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#match" class="tsd-kind-icon">match</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#matchType" class="tsd-kind-icon">match<wbr>Type</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#oauth" class="tsd-kind-icon">oauth</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#oidc" class="tsd-kind-icon">oidc</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#saml" class="tsd-kind-icon">saml</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#trafficPolicy" class="tsd-kind-icon">traffic<wbr>Policy</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#userAgentFilter" class="tsd-kind-icon">user<wbr>Agent<wbr>Filter</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</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="backend" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
|
|
<div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1141">datatypes.ts:1141</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>backend module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="circuitBreaker" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> circuit<wbr>Breaker</h3>
|
|
<div class="tsd-signature tsd-kind-icon">circuit<wbr>Breaker<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1145">datatypes.ts:1145</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>circuit breaker module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="compression" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> compression</h3>
|
|
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1147">datatypes.ts:1147</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>compression module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<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#L1129">datatypes.ts:1129</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#L1137">datatypes.ts:1137</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="edgeId" class="tsd-anchor"></a>
|
|
<h3>edge<wbr>Id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">edge<wbr>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#L1125">datatypes.ts:1125</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="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#L1127">datatypes.ts:1127</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>unique identifier of this edge route</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="ipRestriction" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1143">datatypes.ts:1143</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>ip restriction module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="match" class="tsd-anchor"></a>
|
|
<h3>match</h3>
|
|
<div class="tsd-signature tsd-kind-icon">match<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#L1133">datatypes.ts:1133</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Route selector: "/blog" or "example.com" or "example.com/blog"</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="matchType" class="tsd-anchor"></a>
|
|
<h3>match<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">match<wbr>Type<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#L1131">datatypes.ts:1131</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Type of match to use for this route. Valid values are "exact_path" and "path_prefix".</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#L1139">datatypes.ts:1139</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="oauth" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> oauth</h3>
|
|
<div class="tsd-signature tsd-kind-icon">oauth<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1155">datatypes.ts:1155</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>oauth module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="oidc" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> oidc</h3>
|
|
<div class="tsd-signature tsd-kind-icon">oidc<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOIDC.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1159">datatypes.ts:1159</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>oidc module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="requestHeaders" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr>Headers</h3>
|
|
<div class="tsd-signature tsd-kind-icon">request<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRequestHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1149">datatypes.ts:1149</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>request headers module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="responseHeaders" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Headers</h3>
|
|
<div class="tsd-signature tsd-kind-icon">response<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1151">datatypes.ts:1151</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>response headers module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="saml" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> saml</h3>
|
|
<div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAML.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1157">datatypes.ts:1157</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>saml module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="trafficPolicy" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> traffic<wbr>Policy</h3>
|
|
<div class="tsd-signature tsd-kind-icon">traffic<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTrafficPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTrafficPolicy</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1164">datatypes.ts:1164</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>the traffic policy associated with this edge or null</p>
|
|
</div>
|
|
</div>
|
|
</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#L1135">datatypes.ts:1135</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 class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="userAgentFilter" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr>Agent<wbr>Filter</h3>
|
|
<div class="tsd-signature tsd-kind-icon">user<wbr>Agent<wbr>Filter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointUserAgentFilter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointUserAgentFilter</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1162">datatypes.ts:1162</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="webhookVerification" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Verification</h3>
|
|
<div class="tsd-signature tsd-kind-icon">webhook<wbr>Verification<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1153">datatypes.ts:1153</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>webhook verification module configuration or <code>null</code></p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="websocketTcpConverter" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> websocket<wbr>Tcp<wbr>Converter</h3>
|
|
<div class="tsd-signature tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1161">datatypes.ts:1161</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>websocket to tcp adapter configuration or <code>null</code></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.HTTPSEdgeRoute.html" class="tsd-kind-icon">HTTPSEdge<wbr>Route</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#backend" class="tsd-kind-icon">backend</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#compression" class="tsd-kind-icon">compression</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#description" class="tsd-kind-icon">description</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#id" class="tsd-kind-icon">id</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#match" class="tsd-kind-icon">match</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#matchType" class="tsd-kind-icon">match<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#oauth" class="tsd-kind-icon">oauth</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#oidc" class="tsd-kind-icon">oidc</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#saml" class="tsd-kind-icon">saml</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#trafficPolicy" class="tsd-kind-icon">traffic<wbr>Policy</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#uri" class="tsd-kind-icon">uri</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#userAgentFilter" class="tsd-kind-icon">user<wbr>Agent<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="datatypes.HTTPSEdgeRoute.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</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> |