@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
|
@@ -92,17 +92,18 @@
|
|
|
92
92
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#abuseReports" class="tsd-kind-icon">abuse<wbr>Reports</a></li>
|
|
93
93
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#agentIngresses" class="tsd-kind-icon">agent<wbr>Ingresses</a></li>
|
|
94
94
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a></li>
|
|
95
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#backends" class="tsd-kind-icon">backends</a></li>
|
|
95
96
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a></li>
|
|
96
97
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#credentials" class="tsd-kind-icon">credentials</a></li>
|
|
97
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#
|
|
98
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#edgeModules" class="tsd-kind-icon">edge<wbr>Modules</a></li>
|
|
99
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#edges" class="tsd-kind-icon">edges</a></li>
|
|
100
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#endpoints" class="tsd-kind-icon">endpoints</a></li>
|
|
98
101
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventDestinations" class="tsd-kind-icon">event<wbr>Destinations</a></li>
|
|
99
102
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventSources" class="tsd-kind-icon">event<wbr>Sources</a></li>
|
|
100
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventStreams" class="tsd-kind-icon">event<wbr>Streams</a></li>
|
|
101
103
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventSubscriptions" class="tsd-kind-icon">event<wbr>Subscriptions</a></li>
|
|
102
104
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a></li>
|
|
103
105
|
<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>
|
|
104
106
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a></li>
|
|
105
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#pointcfgModule" class="tsd-kind-icon">pointcfg<wbr>Module</a></li>
|
|
106
107
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#reservedAddrs" class="tsd-kind-icon">reserved<wbr>Addrs</a></li>
|
|
107
108
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#reservedDomains" class="tsd-kind-icon">reserved<wbr>Domains</a></li>
|
|
108
109
|
<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>
|
|
@@ -129,7 +130,7 @@
|
|
|
129
130
|
<li class="tsd-description">
|
|
130
131
|
<aside class="tsd-sources">
|
|
131
132
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
133
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L192">client.ts:192</a></li>
|
|
133
134
|
</ul>
|
|
134
135
|
</aside>
|
|
135
136
|
<div class="tsd-comment tsd-typography">
|
|
@@ -156,7 +157,7 @@
|
|
|
156
157
|
<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>
|
|
157
158
|
<aside class="tsd-sources">
|
|
158
159
|
<ul>
|
|
159
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
160
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L28">client.ts:28</a></li>
|
|
160
161
|
</ul>
|
|
161
162
|
</aside>
|
|
162
163
|
<div class="tsd-comment tsd-typography">
|
|
@@ -172,7 +173,7 @@
|
|
|
172
173
|
<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>
|
|
173
174
|
<aside class="tsd-sources">
|
|
174
175
|
<ul>
|
|
175
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
176
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L29">client.ts:29</a></li>
|
|
176
177
|
</ul>
|
|
177
178
|
</aside>
|
|
178
179
|
</section>
|
|
@@ -182,7 +183,7 @@
|
|
|
182
183
|
<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>
|
|
183
184
|
<aside class="tsd-sources">
|
|
184
185
|
<ul>
|
|
185
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
186
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L37">client.ts:37</a></li>
|
|
186
187
|
</ul>
|
|
187
188
|
</aside>
|
|
188
189
|
<div class="tsd-comment tsd-typography">
|
|
@@ -195,13 +196,62 @@
|
|
|
195
196
|
</div>
|
|
196
197
|
</div>
|
|
197
198
|
</section>
|
|
199
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
200
|
+
<a name="backends" class="tsd-anchor"></a>
|
|
201
|
+
<h3>backends</h3>
|
|
202
|
+
<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>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>
|
|
203
|
+
<aside class="tsd-sources">
|
|
204
|
+
<ul>
|
|
205
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L137">client.ts:137</a></li>
|
|
206
|
+
</ul>
|
|
207
|
+
</aside>
|
|
208
|
+
<div class="tsd-type-declaration">
|
|
209
|
+
<h4>Type declaration</h4>
|
|
210
|
+
<ul class="tsd-parameters">
|
|
211
|
+
<li class="tsd-parameter">
|
|
212
|
+
<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>
|
|
213
|
+
<div class="tsd-comment tsd-typography">
|
|
214
|
+
<div class="lead">
|
|
215
|
+
<p>A Failover backend defines failover behavior within a list of referenced
|
|
216
|
+
backends. Traffic is sent to the first backend in the list. If that backend
|
|
217
|
+
is offline or no connection can be established, ngrok attempts to connect to
|
|
218
|
+
the next backend in the list until one is successful.</p>
|
|
219
|
+
</div>
|
|
220
|
+
</div>
|
|
221
|
+
</li>
|
|
222
|
+
<li class="tsd-parameter">
|
|
223
|
+
<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>
|
|
224
|
+
</li>
|
|
225
|
+
<li class="tsd-parameter">
|
|
226
|
+
<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>
|
|
227
|
+
<div class="tsd-comment tsd-typography">
|
|
228
|
+
<div class="lead">
|
|
229
|
+
<p>A Tunnel Group Backend balances traffic among all online tunnels that match
|
|
230
|
+
a label selector.</p>
|
|
231
|
+
</div>
|
|
232
|
+
</div>
|
|
233
|
+
</li>
|
|
234
|
+
<li class="tsd-parameter">
|
|
235
|
+
<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>
|
|
236
|
+
<div class="tsd-comment tsd-typography">
|
|
237
|
+
<div class="lead">
|
|
238
|
+
<p>A Weighted Backend balances traffic among the referenced backends. Traffic
|
|
239
|
+
is assigned proportionally to each based on its weight. The percentage of
|
|
240
|
+
traffic is calculated by dividing a backend's weight by the sum of all
|
|
241
|
+
weights.</p>
|
|
242
|
+
</div>
|
|
243
|
+
</div>
|
|
244
|
+
</li>
|
|
245
|
+
</ul>
|
|
246
|
+
</div>
|
|
247
|
+
</section>
|
|
198
248
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
199
249
|
<a name="certificateAuthorities" class="tsd-anchor"></a>
|
|
200
250
|
<h3>certificate<wbr>Authorities</h3>
|
|
201
251
|
<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>
|
|
202
252
|
<aside class="tsd-sources">
|
|
203
253
|
<ul>
|
|
204
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
254
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L45">client.ts:45</a></li>
|
|
205
255
|
</ul>
|
|
206
256
|
</aside>
|
|
207
257
|
<div class="tsd-comment tsd-typography">
|
|
@@ -220,7 +270,7 @@
|
|
|
220
270
|
<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>
|
|
221
271
|
<aside class="tsd-sources">
|
|
222
272
|
<ul>
|
|
223
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
273
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L52">client.ts:52</a></li>
|
|
224
274
|
</ul>
|
|
225
275
|
</aside>
|
|
226
276
|
<div class="tsd-comment tsd-typography">
|
|
@@ -233,19 +283,118 @@
|
|
|
233
283
|
</div>
|
|
234
284
|
</section>
|
|
235
285
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
236
|
-
<a name="
|
|
237
|
-
<h3>
|
|
238
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
286
|
+
<a name="edgeModules" class="tsd-anchor"></a>
|
|
287
|
+
<h3>edge<wbr>Modules</h3>
|
|
288
|
+
<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>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>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></div>
|
|
289
|
+
<aside class="tsd-sources">
|
|
290
|
+
<ul>
|
|
291
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L165">client.ts:165</a></li>
|
|
292
|
+
</ul>
|
|
293
|
+
</aside>
|
|
294
|
+
<div class="tsd-type-declaration">
|
|
295
|
+
<h4>Type declaration</h4>
|
|
296
|
+
<ul class="tsd-parameters">
|
|
297
|
+
<li class="tsd-parameter">
|
|
298
|
+
<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>
|
|
299
|
+
</li>
|
|
300
|
+
<li class="tsd-parameter">
|
|
301
|
+
<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>
|
|
302
|
+
</li>
|
|
303
|
+
<li class="tsd-parameter">
|
|
304
|
+
<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>
|
|
305
|
+
</li>
|
|
306
|
+
<li class="tsd-parameter">
|
|
307
|
+
<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>
|
|
308
|
+
</li>
|
|
309
|
+
<li class="tsd-parameter">
|
|
310
|
+
<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>
|
|
311
|
+
</li>
|
|
312
|
+
<li class="tsd-parameter">
|
|
313
|
+
<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>
|
|
314
|
+
</li>
|
|
315
|
+
<li class="tsd-parameter">
|
|
316
|
+
<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>
|
|
317
|
+
</li>
|
|
318
|
+
<li class="tsd-parameter">
|
|
319
|
+
<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>
|
|
320
|
+
</li>
|
|
321
|
+
<li class="tsd-parameter">
|
|
322
|
+
<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>
|
|
323
|
+
</li>
|
|
324
|
+
<li class="tsd-parameter">
|
|
325
|
+
<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>
|
|
326
|
+
</li>
|
|
327
|
+
<li class="tsd-parameter">
|
|
328
|
+
<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>
|
|
329
|
+
</li>
|
|
330
|
+
<li class="tsd-parameter">
|
|
331
|
+
<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>
|
|
332
|
+
</li>
|
|
333
|
+
<li class="tsd-parameter">
|
|
334
|
+
<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>
|
|
335
|
+
</li>
|
|
336
|
+
<li class="tsd-parameter">
|
|
337
|
+
<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>
|
|
338
|
+
</li>
|
|
339
|
+
<li class="tsd-parameter">
|
|
340
|
+
<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>
|
|
341
|
+
</li>
|
|
342
|
+
<li class="tsd-parameter">
|
|
343
|
+
<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>
|
|
344
|
+
</li>
|
|
345
|
+
<li class="tsd-parameter">
|
|
346
|
+
<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>
|
|
347
|
+
</li>
|
|
348
|
+
<li class="tsd-parameter">
|
|
349
|
+
<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>
|
|
350
|
+
</li>
|
|
351
|
+
<li class="tsd-parameter">
|
|
352
|
+
<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>
|
|
353
|
+
</li>
|
|
354
|
+
</ul>
|
|
355
|
+
</div>
|
|
356
|
+
</section>
|
|
357
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
358
|
+
<a name="edges" class="tsd-anchor"></a>
|
|
359
|
+
<h3>edges</h3>
|
|
360
|
+
<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>
|
|
239
361
|
<aside class="tsd-sources">
|
|
240
362
|
<ul>
|
|
241
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
363
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L159">client.ts:159</a></li>
|
|
364
|
+
</ul>
|
|
365
|
+
</aside>
|
|
366
|
+
<div class="tsd-type-declaration">
|
|
367
|
+
<h4>Type declaration</h4>
|
|
368
|
+
<ul class="tsd-parameters">
|
|
369
|
+
<li class="tsd-parameter">
|
|
370
|
+
<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>
|
|
371
|
+
</li>
|
|
372
|
+
<li class="tsd-parameter">
|
|
373
|
+
<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>
|
|
374
|
+
</li>
|
|
375
|
+
<li class="tsd-parameter">
|
|
376
|
+
<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>
|
|
377
|
+
</li>
|
|
378
|
+
<li class="tsd-parameter">
|
|
379
|
+
<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>
|
|
380
|
+
</li>
|
|
381
|
+
</ul>
|
|
382
|
+
</div>
|
|
383
|
+
</section>
|
|
384
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
385
|
+
<a name="endpoints" class="tsd-anchor"></a>
|
|
386
|
+
<h3>endpoints</h3>
|
|
387
|
+
<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>
|
|
388
|
+
<aside class="tsd-sources">
|
|
389
|
+
<ul>
|
|
390
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L58">client.ts:58</a></li>
|
|
242
391
|
</ul>
|
|
243
392
|
</aside>
|
|
244
393
|
<div class="tsd-comment tsd-typography">
|
|
245
394
|
<div class="lead">
|
|
246
|
-
<p>
|
|
247
|
-
|
|
248
|
-
|
|
395
|
+
<p>Endpoints provides an API for querying the endpoint objects
|
|
396
|
+
which define what tunnel or edge is used to serve a hostport.
|
|
397
|
+
Only active endpoints associated with a tunnel or backend are returned.</p>
|
|
249
398
|
</div>
|
|
250
399
|
</div>
|
|
251
400
|
</section>
|
|
@@ -255,7 +404,7 @@
|
|
|
255
404
|
<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>
|
|
256
405
|
<aside class="tsd-sources">
|
|
257
406
|
<ul>
|
|
258
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
407
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L59">client.ts:59</a></li>
|
|
259
408
|
</ul>
|
|
260
409
|
</aside>
|
|
261
410
|
</section>
|
|
@@ -265,17 +414,7 @@
|
|
|
265
414
|
<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>
|
|
266
415
|
<aside class="tsd-sources">
|
|
267
416
|
<ul>
|
|
268
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
269
|
-
</ul>
|
|
270
|
-
</aside>
|
|
271
|
-
</section>
|
|
272
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
273
|
-
<a name="eventStreams" class="tsd-anchor"></a>
|
|
274
|
-
<h3>event<wbr>Streams</h3>
|
|
275
|
-
<div class="tsd-signature tsd-kind-icon">event<wbr>Streams<span class="tsd-signature-symbol">:</span> <a href="services.EventStreams.html" class="tsd-signature-type" data-tsd-kind="Class">EventStreams</a></div>
|
|
276
|
-
<aside class="tsd-sources">
|
|
277
|
-
<ul>
|
|
278
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L59">client.ts:59</a></li>
|
|
417
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L61">client.ts:61</a></li>
|
|
279
418
|
</ul>
|
|
280
419
|
</aside>
|
|
281
420
|
</section>
|
|
@@ -285,7 +424,7 @@
|
|
|
285
424
|
<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>
|
|
286
425
|
<aside class="tsd-sources">
|
|
287
426
|
<ul>
|
|
288
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
427
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L60">client.ts:60</a></li>
|
|
289
428
|
</ul>
|
|
290
429
|
</aside>
|
|
291
430
|
</section>
|
|
@@ -295,7 +434,7 @@
|
|
|
295
434
|
<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>
|
|
296
435
|
<aside class="tsd-sources">
|
|
297
436
|
<ul>
|
|
298
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
437
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L68">client.ts:68</a></li>
|
|
299
438
|
</ul>
|
|
300
439
|
</aside>
|
|
301
440
|
<div class="tsd-comment tsd-typography">
|
|
@@ -313,7 +452,7 @@
|
|
|
313
452
|
<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>
|
|
314
453
|
<aside class="tsd-sources">
|
|
315
454
|
<ul>
|
|
316
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
455
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L73">client.ts:73</a></li>
|
|
317
456
|
</ul>
|
|
318
457
|
</aside>
|
|
319
458
|
<div class="tsd-comment tsd-typography">
|
|
@@ -329,13 +468,13 @@
|
|
|
329
468
|
<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>
|
|
330
469
|
<aside class="tsd-sources">
|
|
331
470
|
<ul>
|
|
332
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
471
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L82">client.ts:82</a></li>
|
|
333
472
|
</ul>
|
|
334
473
|
</aside>
|
|
335
474
|
<div class="tsd-comment tsd-typography">
|
|
336
475
|
<div class="lead">
|
|
337
476
|
<p>An IP restriction is a restriction placed on the CIDRs that are allowed to
|
|
338
|
-
|
|
477
|
+
initiate traffic to a specific aspect of your ngrok account. An IP
|
|
339
478
|
restriction has a type which defines the ingress it applies to. IP
|
|
340
479
|
restrictions can be used to enforce the source IPs that can make API
|
|
341
480
|
requests, log in to the dashboard, start ngrok agents, and connect to your
|
|
@@ -343,64 +482,13 @@
|
|
|
343
482
|
</div>
|
|
344
483
|
</div>
|
|
345
484
|
</section>
|
|
346
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
347
|
-
<a name="pointcfgModule" class="tsd-anchor"></a>
|
|
348
|
-
<h3>pointcfg<wbr>Module</h3>
|
|
349
|
-
<div class="tsd-signature tsd-kind-icon">pointcfg<wbr>Module<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>endpointCircuitBreakerModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointCircuitBreakerModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointCircuitBreakerModule</a><span class="tsd-signature-symbol">; </span>endpointCompressionModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointCompressionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointCompressionModule</a><span class="tsd-signature-symbol">; </span>endpointIpPolicyModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointIPPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointIPPolicyModule</a><span class="tsd-signature-symbol">; </span>endpointLoggingModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointLoggingModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointLoggingModule</a><span class="tsd-signature-symbol">; </span>endpointMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointMutualTLSModule</a><span class="tsd-signature-symbol">; </span>endpointOAuthModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointOAuthModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointOAuthModule</a><span class="tsd-signature-symbol">; </span>endpointOidcModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointOIDCModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointOIDCModule</a><span class="tsd-signature-symbol">; </span>endpointRequestHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointRequestHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointRequestHeadersModule</a><span class="tsd-signature-symbol">; </span>endpointResponseHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointResponseHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointResponseHeadersModule</a><span class="tsd-signature-symbol">; </span>endpointSamlModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointSAMLModule</a><span class="tsd-signature-symbol">; </span>endpointTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointTLSTerminationModule</a><span class="tsd-signature-symbol">; </span>endpointWebhookValidationModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointWebhookValidationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointWebhookValidationModule</a><span class="tsd-signature-symbol"> }</span></div>
|
|
350
|
-
<aside class="tsd-sources">
|
|
351
|
-
<ul>
|
|
352
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L138">client.ts:138</a></li>
|
|
353
|
-
</ul>
|
|
354
|
-
</aside>
|
|
355
|
-
<div class="tsd-type-declaration">
|
|
356
|
-
<h4>Type declaration</h4>
|
|
357
|
-
<ul class="tsd-parameters">
|
|
358
|
-
<li class="tsd-parameter">
|
|
359
|
-
<h5>endpoint<wbr>Circuit<wbr>Breaker<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointCircuitBreakerModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointCircuitBreakerModule</a></h5>
|
|
360
|
-
</li>
|
|
361
|
-
<li class="tsd-parameter">
|
|
362
|
-
<h5>endpoint<wbr>Compression<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointCompressionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointCompressionModule</a></h5>
|
|
363
|
-
</li>
|
|
364
|
-
<li class="tsd-parameter">
|
|
365
|
-
<h5>endpoint<wbr>IpPolicy<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointIPPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointIPPolicyModule</a></h5>
|
|
366
|
-
</li>
|
|
367
|
-
<li class="tsd-parameter">
|
|
368
|
-
<h5>endpoint<wbr>Logging<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointLoggingModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointLoggingModule</a></h5>
|
|
369
|
-
</li>
|
|
370
|
-
<li class="tsd-parameter">
|
|
371
|
-
<h5>endpoint<wbr>Mutual<wbr>Tls<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointMutualTLSModule</a></h5>
|
|
372
|
-
</li>
|
|
373
|
-
<li class="tsd-parameter">
|
|
374
|
-
<h5>endpointOAuth<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointOAuthModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointOAuthModule</a></h5>
|
|
375
|
-
</li>
|
|
376
|
-
<li class="tsd-parameter">
|
|
377
|
-
<h5>endpoint<wbr>Oidc<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointOIDCModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointOIDCModule</a></h5>
|
|
378
|
-
</li>
|
|
379
|
-
<li class="tsd-parameter">
|
|
380
|
-
<h5>endpoint<wbr>Request<wbr>Headers<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointRequestHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointRequestHeadersModule</a></h5>
|
|
381
|
-
</li>
|
|
382
|
-
<li class="tsd-parameter">
|
|
383
|
-
<h5>endpoint<wbr>Response<wbr>Headers<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointResponseHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointResponseHeadersModule</a></h5>
|
|
384
|
-
</li>
|
|
385
|
-
<li class="tsd-parameter">
|
|
386
|
-
<h5>endpoint<wbr>Saml<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointSAMLModule</a></h5>
|
|
387
|
-
</li>
|
|
388
|
-
<li class="tsd-parameter">
|
|
389
|
-
<h5>endpoint<wbr>Tls<wbr>Termination<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointTLSTerminationModule</a></h5>
|
|
390
|
-
</li>
|
|
391
|
-
<li class="tsd-parameter">
|
|
392
|
-
<h5>endpoint<wbr>Webhook<wbr>Validation<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EndpointWebhookValidationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointWebhookValidationModule</a></h5>
|
|
393
|
-
</li>
|
|
394
|
-
</ul>
|
|
395
|
-
</div>
|
|
396
|
-
</section>
|
|
397
485
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
398
486
|
<a name="reservedAddrs" class="tsd-anchor"></a>
|
|
399
487
|
<h3>reserved<wbr>Addrs</h3>
|
|
400
488
|
<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>
|
|
401
489
|
<aside class="tsd-sources">
|
|
402
490
|
<ul>
|
|
403
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
491
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L88">client.ts:88</a></li>
|
|
404
492
|
</ul>
|
|
405
493
|
</aside>
|
|
406
494
|
<div class="tsd-comment tsd-typography">
|
|
@@ -417,7 +505,7 @@
|
|
|
417
505
|
<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>
|
|
418
506
|
<aside class="tsd-sources">
|
|
419
507
|
<ul>
|
|
420
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
508
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L95">client.ts:95</a></li>
|
|
421
509
|
</ul>
|
|
422
510
|
</aside>
|
|
423
511
|
<div class="tsd-comment tsd-typography">
|
|
@@ -435,7 +523,7 @@
|
|
|
435
523
|
<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>
|
|
436
524
|
<aside class="tsd-sources">
|
|
437
525
|
<ul>
|
|
438
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
526
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L100">client.ts:100</a></li>
|
|
439
527
|
</ul>
|
|
440
528
|
</aside>
|
|
441
529
|
<div class="tsd-comment tsd-typography">
|
|
@@ -451,7 +539,7 @@
|
|
|
451
539
|
<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>
|
|
452
540
|
<aside class="tsd-sources">
|
|
453
541
|
<ul>
|
|
454
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
542
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L105">client.ts:105</a></li>
|
|
455
543
|
</ul>
|
|
456
544
|
</aside>
|
|
457
545
|
<div class="tsd-comment tsd-typography">
|
|
@@ -467,7 +555,7 @@
|
|
|
467
555
|
<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>
|
|
468
556
|
<aside class="tsd-sources">
|
|
469
557
|
<ul>
|
|
470
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
558
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L111">client.ts:111</a></li>
|
|
471
559
|
</ul>
|
|
472
560
|
</aside>
|
|
473
561
|
<div class="tsd-comment tsd-typography">
|
|
@@ -484,7 +572,7 @@
|
|
|
484
572
|
<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>
|
|
485
573
|
<aside class="tsd-sources">
|
|
486
574
|
<ul>
|
|
487
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
575
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L117">client.ts:117</a></li>
|
|
488
576
|
</ul>
|
|
489
577
|
</aside>
|
|
490
578
|
<div class="tsd-comment tsd-typography">
|
|
@@ -501,7 +589,7 @@
|
|
|
501
589
|
<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>
|
|
502
590
|
<aside class="tsd-sources">
|
|
503
591
|
<ul>
|
|
504
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
592
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L125">client.ts:125</a></li>
|
|
505
593
|
</ul>
|
|
506
594
|
</aside>
|
|
507
595
|
<div class="tsd-comment tsd-typography">
|
|
@@ -520,7 +608,7 @@
|
|
|
520
608
|
<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>
|
|
521
609
|
<aside class="tsd-sources">
|
|
522
610
|
<ul>
|
|
523
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
611
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L131">client.ts:131</a></li>
|
|
524
612
|
</ul>
|
|
525
613
|
</aside>
|
|
526
614
|
<div class="tsd-comment tsd-typography">
|
|
@@ -537,7 +625,7 @@
|
|
|
537
625
|
<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>
|
|
538
626
|
<aside class="tsd-sources">
|
|
539
627
|
<ul>
|
|
540
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
628
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L136">client.ts:136</a></li>
|
|
541
629
|
</ul>
|
|
542
630
|
</aside>
|
|
543
631
|
<div class="tsd-comment tsd-typography">
|
|
@@ -585,6 +673,9 @@
|
|
|
585
673
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
586
674
|
<a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a>
|
|
587
675
|
</li>
|
|
676
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
677
|
+
<a href="client.Ngrok.html#backends" class="tsd-kind-icon">backends</a>
|
|
678
|
+
</li>
|
|
588
679
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
589
680
|
<a href="client.Ngrok.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a>
|
|
590
681
|
</li>
|
|
@@ -592,16 +683,19 @@
|
|
|
592
683
|
<a href="client.Ngrok.html#credentials" class="tsd-kind-icon">credentials</a>
|
|
593
684
|
</li>
|
|
594
685
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
595
|
-
<a href="client.Ngrok.html#
|
|
686
|
+
<a href="client.Ngrok.html#edgeModules" class="tsd-kind-icon">edge<wbr>Modules</a>
|
|
596
687
|
</li>
|
|
597
688
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
598
|
-
<a href="client.Ngrok.html#
|
|
689
|
+
<a href="client.Ngrok.html#edges" class="tsd-kind-icon">edges</a>
|
|
599
690
|
</li>
|
|
600
691
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
601
|
-
<a href="client.Ngrok.html#
|
|
692
|
+
<a href="client.Ngrok.html#endpoints" class="tsd-kind-icon">endpoints</a>
|
|
693
|
+
</li>
|
|
694
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
695
|
+
<a href="client.Ngrok.html#eventDestinations" class="tsd-kind-icon">event<wbr>Destinations</a>
|
|
602
696
|
</li>
|
|
603
697
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
604
|
-
<a href="client.Ngrok.html#
|
|
698
|
+
<a href="client.Ngrok.html#eventSources" class="tsd-kind-icon">event<wbr>Sources</a>
|
|
605
699
|
</li>
|
|
606
700
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
607
701
|
<a href="client.Ngrok.html#eventSubscriptions" class="tsd-kind-icon">event<wbr>Subscriptions</a>
|
|
@@ -615,9 +709,6 @@
|
|
|
615
709
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
616
710
|
<a href="client.Ngrok.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a>
|
|
617
711
|
</li>
|
|
618
|
-
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
619
|
-
<a href="client.Ngrok.html#pointcfgModule" class="tsd-kind-icon">pointcfg<wbr>Module</a>
|
|
620
|
-
</li>
|
|
621
712
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
622
713
|
<a href="client.Ngrok.html#reservedAddrs" class="tsd-kind-icon">reserved<wbr>Addrs</a>
|
|
623
714
|
</li>
|