@ngrok/ngrok-api 0.3.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -44
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +191 -100
- package/docs/classes/services.APIKeys.html +6 -105
- package/docs/classes/services.AbuseReports.html +3 -102
- package/docs/classes/services.AgentIngresses.html +6 -105
- package/docs/classes/services.CertificateAuthorities.html +6 -105
- package/docs/classes/services.Credentials.html +6 -105
- package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
- package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
- package/docs/classes/{services.EndpointCircuitBreakerModule.html → services.EdgeRouteIPRestrictionModule.html} +28 -127
- package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
- package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
- package/docs/classes/{services.EndpointResponseHeadersModule.html → services.EdgeRouteRequestHeadersModule.html} +28 -127
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
- package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
- package/docs/classes/services.EdgesHTTPS.html +343 -0
- package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
- package/docs/classes/services.EdgesTCP.html +343 -0
- package/docs/classes/services.EdgesTLS.html +343 -0
- package/docs/classes/services.Endpoints.html +256 -0
- package/docs/classes/services.EventDestinations.html +7 -106
- package/docs/classes/services.EventSources.html +6 -105
- package/docs/classes/services.EventSubscriptions.html +6 -105
- package/docs/classes/services.FailoverBackends.html +353 -0
- package/docs/classes/services.HTTPResponseBackends.html +318 -0
- package/docs/classes/{services.EndpointMutualTLSModule.html → services.HTTPSEdgeMutualTLSModule.html} +22 -121
- package/docs/classes/{services.EndpointTLSTerminationModule.html → services.HTTPSEdgeTLSTerminationModule.html} +22 -121
- package/docs/classes/services.IPPolicies.html +6 -105
- package/docs/classes/services.IPPolicyRules.html +6 -105
- package/docs/classes/services.IPRestrictions.html +7 -106
- package/docs/classes/services.ReservedAddrs.html +6 -137
- package/docs/classes/services.ReservedDomains.html +8 -171
- package/docs/classes/services.SSHCertificateAuthorities.html +6 -105
- package/docs/classes/services.SSHCredentials.html +6 -105
- package/docs/classes/services.SSHHostCertificates.html +6 -105
- package/docs/classes/services.SSHUserCertificates.html +6 -105
- package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} +25 -124
- package/docs/classes/{services.EndpointIPPolicyModule.html → services.TCPEdgeIPRestrictionModule.html} +22 -121
- package/docs/classes/services.TLSCertificates.html +6 -105
- package/docs/classes/{services.EndpointLoggingModule.html → services.TLSEdgeBackendModule.html} +25 -124
- package/docs/classes/{services.EndpointOIDCModule.html → services.TLSEdgeIPRestrictionModule.html} +25 -124
- package/docs/classes/{services.EndpointOAuthModule.html → services.TLSEdgeMutualTLSModule.html} +25 -124
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
- package/docs/classes/services.TunnelGroupBackends.html +351 -0
- package/docs/classes/services.TunnelSessions.html +6 -105
- package/docs/classes/services.Tunnels.html +34 -101
- package/docs/classes/{services.EventStreams.html → services.WeightedBackends.html} +51 -140
- package/docs/index.html +22 -43
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +6 -6
- package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
- package/docs/interfaces/datatypes.APIKeyList.html +3 -3
- package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
- package/docs/interfaces/datatypes.AWSAuth.html +2 -2
- package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
- package/docs/interfaces/datatypes.AWSRole.html +1 -1
- package/docs/interfaces/datatypes.AbuseReport.html +7 -7
- package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +8 -8
- package/docs/interfaces/datatypes.AgentIngressCreate.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +8 -8
- package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/{datatypes.EndpointOIDCReplace.html → datatypes.EdgeBackendReplace.html} +12 -12
- package/docs/interfaces/{datatypes.EndpointIPPolicyReplace.html → datatypes.EdgeIPRestrictionReplace.html} +11 -11
- package/docs/interfaces/{datatypes.EndpointMutualTLSReplace.html → datatypes.EdgeMutualTLSReplace.html} +11 -11
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointCompressionReplace.html → datatypes.EdgeRouteCompressionReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointCircuitBreakerReplace.html → datatypes.EdgeRouteItem.html} +27 -17
- package/docs/interfaces/{datatypes.EndpointOAuthReplace.html → datatypes.EdgeRouteOAuthReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointRequestHeadersReplace.html → datatypes.EdgeRouteRequestHeadersReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointSAMLReplace.html → datatypes.EdgeRouteSAMLReplace.html} +25 -11
- package/docs/interfaces/{datatypes.EndpointWebhookValidationReplace.html → datatypes.EdgeRouteWebhookVerificationReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointResponseHeadersReplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +12 -12
- package/docs/interfaces/{datatypes.EndpointTLSTerminationReplace.html → datatypes.EdgeTLSTerminationReplace.html} +11 -11
- package/docs/interfaces/datatypes.Endpoint.html +395 -0
- package/docs/interfaces/{datatypes.EndpointLogging.html → datatypes.EndpointBackend.html} +19 -19
- package/docs/interfaces/{datatypes.EndpointLoggingMutate.html → datatypes.EndpointBackendMutate.html} +19 -19
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +205 -0
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +3 -3
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +186 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +167 -0
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +7 -7
- package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
- package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventSource.html +2 -2
- package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
- package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
- package/docs/interfaces/datatypes.EventSourceList.html +2 -2
- package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
- package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
- package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
- package/docs/interfaces/datatypes.EventSubscription.html +7 -7
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +5 -5
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +6 -6
- package/docs/interfaces/datatypes.EventTarget.html +3 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/{datatypes.EventStreamCreate.html → datatypes.FailoverBackend.html} +44 -44
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +205 -0
- package/docs/interfaces/datatypes.FailoverBackendList.html +205 -0
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +219 -0
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +243 -0
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +190 -0
- package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.HTTPResponseBackendUpdate.html} +40 -45
- package/docs/interfaces/{datatypes.EventStream.html → datatypes.HTTPSEdge.html} +58 -63
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
- package/docs/interfaces/{datatypes.EventStreamList.html → datatypes.HTTPSEdgeList.html} +20 -20
- package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRoute.html} +123 -104
- package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
- package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRouteUpdate.html} +115 -77
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +257 -0
- package/docs/interfaces/datatypes.IPPolicy.html +5 -24
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -21
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +26 -7
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +23 -4
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +8 -8
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
- package/docs/interfaces/datatypes.IPRestrictionList.html +4 -4
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -26
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -22
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -22
- package/docs/interfaces/datatypes.ReservedDomain.html +12 -50
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -44
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -43
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +7 -7
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +15 -15
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +10 -10
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TCPEdge.html +295 -0
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +238 -0
- package/docs/interfaces/datatypes.TCPEdgeList.html +205 -0
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +257 -0
- package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
- package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TLSEdge.html +323 -0
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
- package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +285 -0
- package/docs/interfaces/datatypes.Tunnel.html +85 -9
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +205 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +205 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +219 -0
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +10 -10
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.WeightedBackend.html +262 -0
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
- package/docs/interfaces/{datatypes.EndpointConfigurationList.html → datatypes.WeightedBackendList.html} +19 -19
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
- package/docs/modules/datatypes.html +197 -69
- package/docs/modules/services.html +85 -29
- package/lib/client.d.ts +53 -19
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +43 -19
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +575 -241
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +358 -138
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +1367 -528
- package/lib/services.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +96 -39
- package/src/datatypes.ts +623 -257
- package/src/services.ts +1363 -543
- package/docs/classes/services.EndpointCompressionModule.html +0 -369
- package/docs/classes/services.EndpointConfigurations.html +0 -451
- package/docs/classes/services.EndpointRequestHeadersModule.html +0 -369
- package/docs/classes/services.EndpointWebhookValidationModule.html +0 -369
- package/docs/interfaces/datatypes.EndpointLoggingReplace.html +0 -176
- package/test/endpointConfigurations.test.js +0 -67
|
@@ -83,7 +83,11 @@
|
|
|
83
83
|
<section class="tsd-index-section ">
|
|
84
84
|
<h3>Properties</h3>
|
|
85
85
|
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#backends" class="tsd-kind-icon">backends</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#endpoint" class="tsd-kind-icon">endpoint</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#forwardsTo" class="tsd-kind-icon">forwards<wbr>To</a></li>
|
|
86
89
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#id" class="tsd-kind-icon">id</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#labels" class="tsd-kind-icon">labels</a></li>
|
|
87
91
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
88
92
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#proto" class="tsd-kind-icon">proto</a></li>
|
|
89
93
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a></li>
|
|
@@ -97,13 +101,58 @@
|
|
|
97
101
|
</section>
|
|
98
102
|
<section class="tsd-panel-group tsd-member-group ">
|
|
99
103
|
<h2>Properties</h2>
|
|
104
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
105
|
+
<a name="backends" class="tsd-anchor"></a>
|
|
106
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> backends</h3>
|
|
107
|
+
<div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
|
|
108
|
+
<aside class="tsd-sources">
|
|
109
|
+
<ul>
|
|
110
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1934">datatypes.ts:1934</a></li>
|
|
111
|
+
</ul>
|
|
112
|
+
</aside>
|
|
113
|
+
<div class="tsd-comment tsd-typography">
|
|
114
|
+
<div class="lead">
|
|
115
|
+
<p>tunnel group backends served by this backend tunnel</p>
|
|
116
|
+
</div>
|
|
117
|
+
</div>
|
|
118
|
+
</section>
|
|
119
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
120
|
+
<a name="endpoint" class="tsd-anchor"></a>
|
|
121
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> endpoint</h3>
|
|
122
|
+
<div class="tsd-signature tsd-kind-icon">endpoint<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
123
|
+
<aside class="tsd-sources">
|
|
124
|
+
<ul>
|
|
125
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1930">datatypes.ts:1930</a></li>
|
|
126
|
+
</ul>
|
|
127
|
+
</aside>
|
|
128
|
+
<div class="tsd-comment tsd-typography">
|
|
129
|
+
<div class="lead">
|
|
130
|
+
<p>the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel</p>
|
|
131
|
+
</div>
|
|
132
|
+
</div>
|
|
133
|
+
</section>
|
|
134
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
135
|
+
<a name="forwardsTo" class="tsd-anchor"></a>
|
|
136
|
+
<h3>forwards<wbr>To</h3>
|
|
137
|
+
<div class="tsd-signature tsd-kind-icon">forwards<wbr>To<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
138
|
+
<aside class="tsd-sources">
|
|
139
|
+
<ul>
|
|
140
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1936">datatypes.ts:1936</a></li>
|
|
141
|
+
</ul>
|
|
142
|
+
</aside>
|
|
143
|
+
<div class="tsd-comment tsd-typography">
|
|
144
|
+
<div class="lead">
|
|
145
|
+
<p>upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.</p>
|
|
146
|
+
</div>
|
|
147
|
+
</div>
|
|
148
|
+
</section>
|
|
100
149
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
101
150
|
<a name="id" class="tsd-anchor"></a>
|
|
102
151
|
<h3>id</h3>
|
|
103
152
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
104
153
|
<aside class="tsd-sources">
|
|
105
154
|
<ul>
|
|
106
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
155
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1916">datatypes.ts:1916</a></li>
|
|
107
156
|
</ul>
|
|
108
157
|
</aside>
|
|
109
158
|
<div class="tsd-comment tsd-typography">
|
|
@@ -112,13 +161,28 @@
|
|
|
112
161
|
</div>
|
|
113
162
|
</div>
|
|
114
163
|
</section>
|
|
164
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
165
|
+
<a name="labels" class="tsd-anchor"></a>
|
|
166
|
+
<h3>labels</h3>
|
|
167
|
+
<div class="tsd-signature tsd-kind-icon">labels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
|
168
|
+
<aside class="tsd-sources">
|
|
169
|
+
<ul>
|
|
170
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1932">datatypes.ts:1932</a></li>
|
|
171
|
+
</ul>
|
|
172
|
+
</aside>
|
|
173
|
+
<div class="tsd-comment tsd-typography">
|
|
174
|
+
<div class="lead">
|
|
175
|
+
<p>the labels the tunnel group backends will match against, if this is a backend tunnel</p>
|
|
176
|
+
</div>
|
|
177
|
+
</div>
|
|
178
|
+
</section>
|
|
115
179
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
116
180
|
<a name="metadata" class="tsd-anchor"></a>
|
|
117
181
|
<h3>metadata</h3>
|
|
118
182
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
119
183
|
<aside class="tsd-sources">
|
|
120
184
|
<ul>
|
|
121
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
185
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1922">datatypes.ts:1922</a></li>
|
|
122
186
|
</ul>
|
|
123
187
|
</aside>
|
|
124
188
|
<div class="tsd-comment tsd-typography">
|
|
@@ -133,12 +197,12 @@
|
|
|
133
197
|
<div class="tsd-signature tsd-kind-icon">proto<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
134
198
|
<aside class="tsd-sources">
|
|
135
199
|
<ul>
|
|
136
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
200
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1924">datatypes.ts:1924</a></li>
|
|
137
201
|
</ul>
|
|
138
202
|
</aside>
|
|
139
203
|
<div class="tsd-comment tsd-typography">
|
|
140
204
|
<div class="lead">
|
|
141
|
-
<p>tunnel protocol. one of <code>http</code>, <code>https</code>, <code>tcp</code> or <code>tls</code></p>
|
|
205
|
+
<p>tunnel protocol for ephemeral tunnels. one of <code>http</code>, <code>https</code>, <code>tcp</code> or <code>tls</code></p>
|
|
142
206
|
</div>
|
|
143
207
|
</div>
|
|
144
208
|
</section>
|
|
@@ -148,12 +212,12 @@
|
|
|
148
212
|
<div class="tsd-signature tsd-kind-icon">public<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
149
213
|
<aside class="tsd-sources">
|
|
150
214
|
<ul>
|
|
151
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
215
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1918">datatypes.ts:1918</a></li>
|
|
152
216
|
</ul>
|
|
153
217
|
</aside>
|
|
154
218
|
<div class="tsd-comment tsd-typography">
|
|
155
219
|
<div class="lead">
|
|
156
|
-
<p>URL of the tunnel's public endpoint</p>
|
|
220
|
+
<p>URL of the ephemeral tunnel's public endpoint</p>
|
|
157
221
|
</div>
|
|
158
222
|
</div>
|
|
159
223
|
</section>
|
|
@@ -163,7 +227,7 @@
|
|
|
163
227
|
<div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
164
228
|
<aside class="tsd-sources">
|
|
165
229
|
<ul>
|
|
166
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
230
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1926">datatypes.ts:1926</a></li>
|
|
167
231
|
</ul>
|
|
168
232
|
</aside>
|
|
169
233
|
<div class="tsd-comment tsd-typography">
|
|
@@ -178,7 +242,7 @@
|
|
|
178
242
|
<div class="tsd-signature tsd-kind-icon">started<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
179
243
|
<aside class="tsd-sources">
|
|
180
244
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
245
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1920">datatypes.ts:1920</a></li>
|
|
182
246
|
</ul>
|
|
183
247
|
</aside>
|
|
184
248
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,7 +257,7 @@
|
|
|
193
257
|
<div class="tsd-signature tsd-kind-icon">tunnel<wbr>Session<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
194
258
|
<aside class="tsd-sources">
|
|
195
259
|
<ul>
|
|
196
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
260
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1928">datatypes.ts:1928</a></li>
|
|
197
261
|
</ul>
|
|
198
262
|
</aside>
|
|
199
263
|
<div class="tsd-comment tsd-typography">
|
|
@@ -228,9 +292,21 @@
|
|
|
228
292
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
229
293
|
<a href="datatypes.Tunnel.html" class="tsd-kind-icon">Tunnel</a>
|
|
230
294
|
<ul>
|
|
295
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
296
|
+
<a href="datatypes.Tunnel.html#backends" class="tsd-kind-icon">backends</a>
|
|
297
|
+
</li>
|
|
298
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
299
|
+
<a href="datatypes.Tunnel.html#endpoint" class="tsd-kind-icon">endpoint</a>
|
|
300
|
+
</li>
|
|
301
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
302
|
+
<a href="datatypes.Tunnel.html#forwardsTo" class="tsd-kind-icon">forwards<wbr>To</a>
|
|
303
|
+
</li>
|
|
231
304
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
232
305
|
<a href="datatypes.Tunnel.html#id" class="tsd-kind-icon">id</a>
|
|
233
306
|
</li>
|
|
307
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
308
|
+
<a href="datatypes.Tunnel.html#labels" class="tsd-kind-icon">labels</a>
|
|
309
|
+
</li>
|
|
234
310
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
235
311
|
<a href="datatypes.Tunnel.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
236
312
|
</li>
|
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>TunnelGroupBackend | @ngrok/ngrok-api</title>
|
|
7
|
+
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header>
|
|
14
|
+
<div class="tsd-page-toolbar">
|
|
15
|
+
<div class="container">
|
|
16
|
+
<div class="table-wrap">
|
|
17
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
18
|
+
<div class="field">
|
|
19
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
20
|
+
<input id="tsd-search-field" type="text" />
|
|
21
|
+
</div>
|
|
22
|
+
<ul class="results">
|
|
23
|
+
<li class="state loading">Preparing search index...</li>
|
|
24
|
+
<li class="state failure">The search index is not available</li>
|
|
25
|
+
</ul>
|
|
26
|
+
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
|
|
27
|
+
</div>
|
|
28
|
+
<div class="table-cell" id="tsd-widgets">
|
|
29
|
+
<div id="tsd-filter">
|
|
30
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
31
|
+
<div class="tsd-filter-group">
|
|
32
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
33
|
+
<span class="tsd-select-label">All</span>
|
|
34
|
+
<ul class="tsd-select-list">
|
|
35
|
+
<li data-value="public">Public</li>
|
|
36
|
+
<li data-value="protected">Public/Protected</li>
|
|
37
|
+
<li data-value="private" class="selected">All</li>
|
|
38
|
+
</ul>
|
|
39
|
+
</div>
|
|
40
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
41
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
42
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
43
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
47
|
+
</div>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="tsd-page-title">
|
|
52
|
+
<div class="container">
|
|
53
|
+
<ul class="tsd-breadcrumb">
|
|
54
|
+
<li>
|
|
55
|
+
<a href="../modules.html">@ngrok/ngrok-api</a>
|
|
56
|
+
</li>
|
|
57
|
+
<li>
|
|
58
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="datatypes.TunnelGroupBackend.html">TunnelGroupBackend</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface TunnelGroupBackend</h1>
|
|
65
|
+
</div>
|
|
66
|
+
</div>
|
|
67
|
+
</header>
|
|
68
|
+
<div class="container container-main">
|
|
69
|
+
<div class="row">
|
|
70
|
+
<div class="col-8 col-content">
|
|
71
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
72
|
+
<h3>Hierarchy</h3>
|
|
73
|
+
<ul class="tsd-hierarchy">
|
|
74
|
+
<li>
|
|
75
|
+
<span class="target">TunnelGroupBackend</span>
|
|
76
|
+
</li>
|
|
77
|
+
</ul>
|
|
78
|
+
</section>
|
|
79
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
80
|
+
<h2>Index</h2>
|
|
81
|
+
<section class="tsd-panel tsd-index-panel">
|
|
82
|
+
<div class="tsd-index-content">
|
|
83
|
+
<section class="tsd-index-section ">
|
|
84
|
+
<h3>Properties</h3>
|
|
85
|
+
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#description" class="tsd-kind-icon">description</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#id" class="tsd-kind-icon">id</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#labels" class="tsd-kind-icon">labels</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#tunnels" class="tsd-kind-icon">tunnels</a></li>
|
|
92
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
93
|
+
</ul>
|
|
94
|
+
</section>
|
|
95
|
+
</div>
|
|
96
|
+
</section>
|
|
97
|
+
</section>
|
|
98
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
99
|
+
<h2>Properties</h2>
|
|
100
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
101
|
+
<a name="createdAt" class="tsd-anchor"></a>
|
|
102
|
+
<h3>created<wbr>At</h3>
|
|
103
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
104
|
+
<aside class="tsd-sources">
|
|
105
|
+
<ul>
|
|
106
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L242">datatypes.ts:242</a></li>
|
|
107
|
+
</ul>
|
|
108
|
+
</aside>
|
|
109
|
+
<div class="tsd-comment tsd-typography">
|
|
110
|
+
<div class="lead">
|
|
111
|
+
<p>timestamp when the backend was created, RFC 3339 format</p>
|
|
112
|
+
</div>
|
|
113
|
+
</div>
|
|
114
|
+
</section>
|
|
115
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
116
|
+
<a name="description" class="tsd-anchor"></a>
|
|
117
|
+
<h3>description</h3>
|
|
118
|
+
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
119
|
+
<aside class="tsd-sources">
|
|
120
|
+
<ul>
|
|
121
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L244">datatypes.ts:244</a></li>
|
|
122
|
+
</ul>
|
|
123
|
+
</aside>
|
|
124
|
+
<div class="tsd-comment tsd-typography">
|
|
125
|
+
<div class="lead">
|
|
126
|
+
<p>human-readable description of this backend. Optional</p>
|
|
127
|
+
</div>
|
|
128
|
+
</div>
|
|
129
|
+
</section>
|
|
130
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
131
|
+
<a name="id" class="tsd-anchor"></a>
|
|
132
|
+
<h3>id</h3>
|
|
133
|
+
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
134
|
+
<aside class="tsd-sources">
|
|
135
|
+
<ul>
|
|
136
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L238">datatypes.ts:238</a></li>
|
|
137
|
+
</ul>
|
|
138
|
+
</aside>
|
|
139
|
+
<div class="tsd-comment tsd-typography">
|
|
140
|
+
<div class="lead">
|
|
141
|
+
<p>unique identifier for this TunnelGroup backend</p>
|
|
142
|
+
</div>
|
|
143
|
+
</div>
|
|
144
|
+
</section>
|
|
145
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
146
|
+
<a name="labels" class="tsd-anchor"></a>
|
|
147
|
+
<h3>labels</h3>
|
|
148
|
+
<div class="tsd-signature tsd-kind-icon">labels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
|
149
|
+
<aside class="tsd-sources">
|
|
150
|
+
<ul>
|
|
151
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L248">datatypes.ts:248</a></li>
|
|
152
|
+
</ul>
|
|
153
|
+
</aside>
|
|
154
|
+
<div class="tsd-comment tsd-typography">
|
|
155
|
+
<div class="lead">
|
|
156
|
+
<p>labels to watch for tunnels on, e.g. app->foo, dc->bar</p>
|
|
157
|
+
</div>
|
|
158
|
+
</div>
|
|
159
|
+
</section>
|
|
160
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
161
|
+
<a name="metadata" class="tsd-anchor"></a>
|
|
162
|
+
<h3>metadata</h3>
|
|
163
|
+
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
164
|
+
<aside class="tsd-sources">
|
|
165
|
+
<ul>
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L246">datatypes.ts:246</a></li>
|
|
167
|
+
</ul>
|
|
168
|
+
</aside>
|
|
169
|
+
<div class="tsd-comment tsd-typography">
|
|
170
|
+
<div class="lead">
|
|
171
|
+
<p>arbitrary user-defined machine-readable data of this backend. Optional</p>
|
|
172
|
+
</div>
|
|
173
|
+
</div>
|
|
174
|
+
</section>
|
|
175
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
176
|
+
<a name="tunnels" class="tsd-anchor"></a>
|
|
177
|
+
<h3>tunnels</h3>
|
|
178
|
+
<div class="tsd-signature tsd-kind-icon">tunnels<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
|
|
179
|
+
<aside class="tsd-sources">
|
|
180
|
+
<ul>
|
|
181
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L250">datatypes.ts:250</a></li>
|
|
182
|
+
</ul>
|
|
183
|
+
</aside>
|
|
184
|
+
<div class="tsd-comment tsd-typography">
|
|
185
|
+
<div class="lead">
|
|
186
|
+
<p>tunnels matching this backend</p>
|
|
187
|
+
</div>
|
|
188
|
+
</div>
|
|
189
|
+
</section>
|
|
190
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
191
|
+
<a name="uri" class="tsd-anchor"></a>
|
|
192
|
+
<h3>uri</h3>
|
|
193
|
+
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
194
|
+
<aside class="tsd-sources">
|
|
195
|
+
<ul>
|
|
196
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L240">datatypes.ts:240</a></li>
|
|
197
|
+
</ul>
|
|
198
|
+
</aside>
|
|
199
|
+
<div class="tsd-comment tsd-typography">
|
|
200
|
+
<div class="lead">
|
|
201
|
+
<p>URI of the TunnelGroupBackend API resource</p>
|
|
202
|
+
</div>
|
|
203
|
+
</div>
|
|
204
|
+
</section>
|
|
205
|
+
</section>
|
|
206
|
+
</div>
|
|
207
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
208
|
+
<nav class="tsd-navigation primary">
|
|
209
|
+
<ul>
|
|
210
|
+
<li class=" ">
|
|
211
|
+
<a href="../modules.html">Modules</a>
|
|
212
|
+
</li>
|
|
213
|
+
<li class=" tsd-kind-module">
|
|
214
|
+
<a href="../modules/client.html">client</a>
|
|
215
|
+
</li>
|
|
216
|
+
<li class="current tsd-kind-module">
|
|
217
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
218
|
+
</li>
|
|
219
|
+
<li class=" tsd-kind-module">
|
|
220
|
+
<a href="../modules/services.html">services</a>
|
|
221
|
+
</li>
|
|
222
|
+
</ul>
|
|
223
|
+
</nav>
|
|
224
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
225
|
+
<ul class="before-current">
|
|
226
|
+
</ul>
|
|
227
|
+
<ul class="current">
|
|
228
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
229
|
+
<a href="datatypes.TunnelGroupBackend.html" class="tsd-kind-icon">Tunnel<wbr>Group<wbr>Backend</a>
|
|
230
|
+
<ul>
|
|
231
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
232
|
+
<a href="datatypes.TunnelGroupBackend.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
233
|
+
</li>
|
|
234
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
235
|
+
<a href="datatypes.TunnelGroupBackend.html#description" class="tsd-kind-icon">description</a>
|
|
236
|
+
</li>
|
|
237
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
238
|
+
<a href="datatypes.TunnelGroupBackend.html#id" class="tsd-kind-icon">id</a>
|
|
239
|
+
</li>
|
|
240
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
241
|
+
<a href="datatypes.TunnelGroupBackend.html#labels" class="tsd-kind-icon">labels</a>
|
|
242
|
+
</li>
|
|
243
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
244
|
+
<a href="datatypes.TunnelGroupBackend.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
245
|
+
</li>
|
|
246
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
247
|
+
<a href="datatypes.TunnelGroupBackend.html#tunnels" class="tsd-kind-icon">tunnels</a>
|
|
248
|
+
</li>
|
|
249
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
250
|
+
<a href="datatypes.TunnelGroupBackend.html#uri" class="tsd-kind-icon">uri</a>
|
|
251
|
+
</li>
|
|
252
|
+
</ul>
|
|
253
|
+
</li>
|
|
254
|
+
</ul>
|
|
255
|
+
<ul class="after-current">
|
|
256
|
+
</ul>
|
|
257
|
+
</nav>
|
|
258
|
+
</div>
|
|
259
|
+
</div>
|
|
260
|
+
</div>
|
|
261
|
+
<footer class="with-border-bottom">
|
|
262
|
+
<div class="container">
|
|
263
|
+
<h2>Legend</h2>
|
|
264
|
+
<div class="tsd-legend-group">
|
|
265
|
+
<ul class="tsd-legend">
|
|
266
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
267
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
268
|
+
</ul>
|
|
269
|
+
<ul class="tsd-legend">
|
|
270
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
271
|
+
</ul>
|
|
272
|
+
</div>
|
|
273
|
+
</div>
|
|
274
|
+
</footer>
|
|
275
|
+
<div class="container tsd-generator">
|
|
276
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
277
|
+
</div>
|
|
278
|
+
<div class="overlay"></div>
|
|
279
|
+
<script src="../assets/js/main.js"></script>
|
|
280
|
+
</body>
|
|
281
|
+
</html>
|