@ngrok/ngrok-api 0.2.0 → 0.8.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 +0 -28
- package/docs/CNAME +1 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +204 -119
- package/docs/classes/services.APIKeys.html +6 -105
- package/docs/classes/services.AbuseReports.html +3 -102
- package/docs/classes/{services.IPWhitelist.html → services.AgentIngresses.html} +41 -148
- 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.EdgeRouteIPRestrictionModule.html +270 -0
- 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.EventStreams.html → services.FailoverBackends.html} +51 -140
- 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.WeightedBackends.html +353 -0
- package/docs/index.html +0 -27
- 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.EventStream.html → datatypes.AgentIngress.html} +52 -71
- package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
- package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
- package/docs/interfaces/{datatypes.IPWhitelistEntryUpdate.html → datatypes.AgentIngressUpdate.html} +16 -16
- 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 +7 -7
- 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.EndpointCircuitBreakerReplace.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.ReservedDomainCertNSTarget.html → datatypes.EdgeRouteItem.html} +19 -19
- 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.EndpointConfigurationList.html → datatypes.EndpointList.html} +19 -19
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- 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 +33 -14
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +28 -9
- 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.EndpointOIDCReplace.html → datatypes.EndpointWebsocketTCPConverter.html} +16 -25
- 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.IPWhitelistEntry.html → datatypes.FailoverBackend.html} +41 -41
- package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.FailoverBackendCreate.html} +23 -23
- 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.HTTPResponseBackendUpdate.html +257 -0
- package/docs/interfaces/datatypes.HTTPSEdge.html +314 -0
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
- package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRoute.html} +154 -78
- package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
- package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +104 -123
- 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 +3 -3
- 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 +30 -49
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -23
- 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 +14 -14
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
- 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.IPWhitelistEntryList.html → datatypes.TCPEdgeList.html} +22 -22
- package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.TCPEdgeUpdate.html} +43 -48
- 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.EventStreamList.html → datatypes.TLSEdgeList.html} +23 -23
- 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.EventStreamCreate.html → datatypes.WeightedBackend.html} +44 -44
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
- package/docs/interfaces/datatypes.WeightedBackendList.html +205 -0
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
- package/docs/modules/datatypes.html +213 -89
- package/docs/modules/services.html +89 -33
- package/lib/client.d.ts +54 -24
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +45 -22
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +617 -281
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +385 -169
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +1432 -597
- package/lib/services.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +98 -45
- package/src/datatypes.ts +669 -302
- package/src/services.ts +1426 -610
- package/docs/classes/services.EndpointCircuitBreakerModule.html +0 -369
- 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
package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRoute.html}
RENAMED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
-
<title>
|
|
6
|
+
<title>HTTPSEdgeRoute | @ngrok/ngrok-api</title>
|
|
7
7
|
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
8
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
9
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
@@ -58,10 +58,10 @@
|
|
|
58
58
|
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
59
|
</li>
|
|
60
60
|
<li>
|
|
61
|
-
<a href="datatypes.
|
|
61
|
+
<a href="datatypes.HTTPSEdgeRoute.html">HTTPSEdgeRoute</a>
|
|
62
62
|
</li>
|
|
63
63
|
</ul>
|
|
64
|
-
<h1>Interface
|
|
64
|
+
<h1>Interface HTTPSEdgeRoute</h1>
|
|
65
65
|
</div>
|
|
66
66
|
</div>
|
|
67
67
|
</header>
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
<h3>Hierarchy</h3>
|
|
73
73
|
<ul class="tsd-hierarchy">
|
|
74
74
|
<li>
|
|
75
|
-
<span class="target">
|
|
75
|
+
<span class="target">HTTPSEdgeRoute</span>
|
|
76
76
|
</li>
|
|
77
77
|
</ul>
|
|
78
78
|
</section>
|
|
@@ -83,21 +83,25 @@
|
|
|
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.
|
|
87
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
88
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
89
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
90
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
91
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
92
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
93
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
94
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
95
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
96
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
97
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
98
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
99
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
100
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#backend" class="tsd-kind-icon">backend</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#compression" class="tsd-kind-icon">compression</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#description" class="tsd-kind-icon">description</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a></li>
|
|
92
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#id" class="tsd-kind-icon">id</a></li>
|
|
93
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
|
|
94
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#match" class="tsd-kind-icon">match</a></li>
|
|
95
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#matchType" class="tsd-kind-icon">match<wbr>Type</a></li>
|
|
96
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
97
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#oauth" class="tsd-kind-icon">oauth</a></li>
|
|
98
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#oidc" class="tsd-kind-icon">oidc</a></li>
|
|
99
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
|
|
100
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
|
|
101
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#saml" class="tsd-kind-icon">saml</a></li>
|
|
102
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
103
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a></li>
|
|
104
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a></li>
|
|
101
105
|
</ul>
|
|
102
106
|
</section>
|
|
103
107
|
</div>
|
|
@@ -105,13 +109,28 @@
|
|
|
105
109
|
</section>
|
|
106
110
|
<section class="tsd-panel-group tsd-member-group ">
|
|
107
111
|
<h2>Properties</h2>
|
|
112
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
113
|
+
<a name="backend" class="tsd-anchor"></a>
|
|
114
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
|
|
115
|
+
<div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a></div>
|
|
116
|
+
<aside class="tsd-sources">
|
|
117
|
+
<ul>
|
|
118
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L787">datatypes.ts:787</a></li>
|
|
119
|
+
</ul>
|
|
120
|
+
</aside>
|
|
121
|
+
<div class="tsd-comment tsd-typography">
|
|
122
|
+
<div class="lead">
|
|
123
|
+
<p>backend module configuration or <code>null</code></p>
|
|
124
|
+
</div>
|
|
125
|
+
</div>
|
|
126
|
+
</section>
|
|
108
127
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
109
128
|
<a name="circuitBreaker" class="tsd-anchor"></a>
|
|
110
129
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> circuit<wbr>Breaker</h3>
|
|
111
130
|
<div class="tsd-signature tsd-kind-icon">circuit<wbr>Breaker<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</a></div>
|
|
112
131
|
<aside class="tsd-sources">
|
|
113
132
|
<ul>
|
|
114
|
-
<li>Defined in datatypes.ts:
|
|
133
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L791">datatypes.ts:791</a></li>
|
|
115
134
|
</ul>
|
|
116
135
|
</aside>
|
|
117
136
|
<div class="tsd-comment tsd-typography">
|
|
@@ -126,7 +145,7 @@
|
|
|
126
145
|
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</a></div>
|
|
127
146
|
<aside class="tsd-sources">
|
|
128
147
|
<ul>
|
|
129
|
-
<li>Defined in datatypes.ts:
|
|
148
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L793">datatypes.ts:793</a></li>
|
|
130
149
|
</ul>
|
|
131
150
|
</aside>
|
|
132
151
|
<div class="tsd-comment tsd-typography">
|
|
@@ -135,18 +154,48 @@
|
|
|
135
154
|
</div>
|
|
136
155
|
</div>
|
|
137
156
|
</section>
|
|
157
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
158
|
+
<a name="createdAt" class="tsd-anchor"></a>
|
|
159
|
+
<h3>created<wbr>At</h3>
|
|
160
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
161
|
+
<aside class="tsd-sources">
|
|
162
|
+
<ul>
|
|
163
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L775">datatypes.ts:775</a></li>
|
|
164
|
+
</ul>
|
|
165
|
+
</aside>
|
|
166
|
+
<div class="tsd-comment tsd-typography">
|
|
167
|
+
<div class="lead">
|
|
168
|
+
<p>timestamp when the edge configuration was created, RFC 3339 format</p>
|
|
169
|
+
</div>
|
|
170
|
+
</div>
|
|
171
|
+
</section>
|
|
138
172
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
139
173
|
<a name="description" class="tsd-anchor"></a>
|
|
140
|
-
<h3
|
|
174
|
+
<h3>description</h3>
|
|
141
175
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
142
176
|
<aside class="tsd-sources">
|
|
143
177
|
<ul>
|
|
144
|
-
<li>Defined in datatypes.ts:
|
|
178
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L783">datatypes.ts:783</a></li>
|
|
179
|
+
</ul>
|
|
180
|
+
</aside>
|
|
181
|
+
<div class="tsd-comment tsd-typography">
|
|
182
|
+
<div class="lead">
|
|
183
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
184
|
+
</div>
|
|
185
|
+
</div>
|
|
186
|
+
</section>
|
|
187
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
188
|
+
<a name="edgeId" class="tsd-anchor"></a>
|
|
189
|
+
<h3>edge<wbr>Id</h3>
|
|
190
|
+
<div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
191
|
+
<aside class="tsd-sources">
|
|
192
|
+
<ul>
|
|
193
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L771">datatypes.ts:771</a></li>
|
|
145
194
|
</ul>
|
|
146
195
|
</aside>
|
|
147
196
|
<div class="tsd-comment tsd-typography">
|
|
148
197
|
<div class="lead">
|
|
149
|
-
<p>
|
|
198
|
+
<p>unique identifier of this edge</p>
|
|
150
199
|
</div>
|
|
151
200
|
</div>
|
|
152
201
|
</section>
|
|
@@ -156,72 +205,72 @@
|
|
|
156
205
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
157
206
|
<aside class="tsd-sources">
|
|
158
207
|
<ul>
|
|
159
|
-
<li>Defined in datatypes.ts:
|
|
208
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L773">datatypes.ts:773</a></li>
|
|
160
209
|
</ul>
|
|
161
210
|
</aside>
|
|
162
211
|
<div class="tsd-comment tsd-typography">
|
|
163
212
|
<div class="lead">
|
|
164
|
-
<p>unique identifier of this
|
|
213
|
+
<p>unique identifier of this edge route</p>
|
|
165
214
|
</div>
|
|
166
215
|
</div>
|
|
167
216
|
</section>
|
|
168
217
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
169
|
-
<a name="
|
|
170
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>
|
|
171
|
-
<div class="tsd-signature tsd-kind-icon">ip<wbr>
|
|
218
|
+
<a name="ipRestriction" class="tsd-anchor"></a>
|
|
219
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
|
|
220
|
+
<div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
|
|
172
221
|
<aside class="tsd-sources">
|
|
173
222
|
<ul>
|
|
174
|
-
<li>Defined in datatypes.ts:
|
|
223
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L789">datatypes.ts:789</a></li>
|
|
175
224
|
</ul>
|
|
176
225
|
</aside>
|
|
177
226
|
<div class="tsd-comment tsd-typography">
|
|
178
227
|
<div class="lead">
|
|
179
|
-
<p>ip
|
|
228
|
+
<p>ip restriction module configuration or <code>null</code></p>
|
|
180
229
|
</div>
|
|
181
230
|
</div>
|
|
182
231
|
</section>
|
|
183
232
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
184
|
-
<a name="
|
|
185
|
-
<h3
|
|
186
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
233
|
+
<a name="match" class="tsd-anchor"></a>
|
|
234
|
+
<h3>match</h3>
|
|
235
|
+
<div class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
187
236
|
<aside class="tsd-sources">
|
|
188
237
|
<ul>
|
|
189
|
-
<li>Defined in datatypes.ts:
|
|
238
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L779">datatypes.ts:779</a></li>
|
|
190
239
|
</ul>
|
|
191
240
|
</aside>
|
|
192
241
|
<div class="tsd-comment tsd-typography">
|
|
193
242
|
<div class="lead">
|
|
194
|
-
<p>
|
|
243
|
+
<p>Route selector: "/blog" or "example.com" or "example.com/blog"</p>
|
|
195
244
|
</div>
|
|
196
245
|
</div>
|
|
197
246
|
</section>
|
|
198
247
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
199
|
-
<a name="
|
|
200
|
-
<h3
|
|
201
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
248
|
+
<a name="matchType" class="tsd-anchor"></a>
|
|
249
|
+
<h3>match<wbr>Type</h3>
|
|
250
|
+
<div class="tsd-signature tsd-kind-icon">match<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
202
251
|
<aside class="tsd-sources">
|
|
203
252
|
<ul>
|
|
204
|
-
<li>Defined in datatypes.ts:
|
|
253
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L777">datatypes.ts:777</a></li>
|
|
205
254
|
</ul>
|
|
206
255
|
</aside>
|
|
207
256
|
<div class="tsd-comment tsd-typography">
|
|
208
257
|
<div class="lead">
|
|
209
|
-
<p>
|
|
258
|
+
<p>Type of match to use for this route. Valid values are "exact_path" and "path_prefix".</p>
|
|
210
259
|
</div>
|
|
211
260
|
</div>
|
|
212
261
|
</section>
|
|
213
262
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
214
|
-
<a name="
|
|
215
|
-
<h3
|
|
216
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
263
|
+
<a name="metadata" class="tsd-anchor"></a>
|
|
264
|
+
<h3>metadata</h3>
|
|
265
|
+
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
217
266
|
<aside class="tsd-sources">
|
|
218
267
|
<ul>
|
|
219
|
-
<li>Defined in datatypes.ts:
|
|
268
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L785">datatypes.ts:785</a></li>
|
|
220
269
|
</ul>
|
|
221
270
|
</aside>
|
|
222
271
|
<div class="tsd-comment tsd-typography">
|
|
223
272
|
<div class="lead">
|
|
224
|
-
<p>
|
|
273
|
+
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
|
225
274
|
</div>
|
|
226
275
|
</div>
|
|
227
276
|
</section>
|
|
@@ -231,7 +280,7 @@
|
|
|
231
280
|
<div class="tsd-signature tsd-kind-icon">oauth<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
|
|
232
281
|
<aside class="tsd-sources">
|
|
233
282
|
<ul>
|
|
234
|
-
<li>Defined in datatypes.ts:
|
|
283
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L801">datatypes.ts:801</a></li>
|
|
235
284
|
</ul>
|
|
236
285
|
</aside>
|
|
237
286
|
<div class="tsd-comment tsd-typography">
|
|
@@ -246,7 +295,7 @@
|
|
|
246
295
|
<div class="tsd-signature tsd-kind-icon">oidc<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOIDC.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
|
|
247
296
|
<aside class="tsd-sources">
|
|
248
297
|
<ul>
|
|
249
|
-
<li>Defined in datatypes.ts:
|
|
298
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L805">datatypes.ts:805</a></li>
|
|
250
299
|
</ul>
|
|
251
300
|
</aside>
|
|
252
301
|
<div class="tsd-comment tsd-typography">
|
|
@@ -261,7 +310,7 @@
|
|
|
261
310
|
<div class="tsd-signature tsd-kind-icon">request<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRequestHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
|
|
262
311
|
<aside class="tsd-sources">
|
|
263
312
|
<ul>
|
|
264
|
-
<li>Defined in datatypes.ts:
|
|
313
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L795">datatypes.ts:795</a></li>
|
|
265
314
|
</ul>
|
|
266
315
|
</aside>
|
|
267
316
|
<div class="tsd-comment tsd-typography">
|
|
@@ -276,7 +325,7 @@
|
|
|
276
325
|
<div class="tsd-signature tsd-kind-icon">response<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
|
|
277
326
|
<aside class="tsd-sources">
|
|
278
327
|
<ul>
|
|
279
|
-
<li>Defined in datatypes.ts:
|
|
328
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L797">datatypes.ts:797</a></li>
|
|
280
329
|
</ul>
|
|
281
330
|
</aside>
|
|
282
331
|
<div class="tsd-comment tsd-typography">
|
|
@@ -288,10 +337,10 @@
|
|
|
288
337
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
289
338
|
<a name="saml" class="tsd-anchor"></a>
|
|
290
339
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> saml</h3>
|
|
291
|
-
<div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.
|
|
340
|
+
<div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAML.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a></div>
|
|
292
341
|
<aside class="tsd-sources">
|
|
293
342
|
<ul>
|
|
294
|
-
<li>Defined in datatypes.ts:
|
|
343
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L803">datatypes.ts:803</a></li>
|
|
295
344
|
</ul>
|
|
296
345
|
</aside>
|
|
297
346
|
<div class="tsd-comment tsd-typography">
|
|
@@ -301,32 +350,47 @@
|
|
|
301
350
|
</div>
|
|
302
351
|
</section>
|
|
303
352
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
304
|
-
<a name="
|
|
305
|
-
<h3
|
|
306
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
353
|
+
<a name="uri" class="tsd-anchor"></a>
|
|
354
|
+
<h3>uri</h3>
|
|
355
|
+
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
356
|
+
<aside class="tsd-sources">
|
|
357
|
+
<ul>
|
|
358
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L781">datatypes.ts:781</a></li>
|
|
359
|
+
</ul>
|
|
360
|
+
</aside>
|
|
361
|
+
<div class="tsd-comment tsd-typography">
|
|
362
|
+
<div class="lead">
|
|
363
|
+
<p>URI of the edge API resource</p>
|
|
364
|
+
</div>
|
|
365
|
+
</div>
|
|
366
|
+
</section>
|
|
367
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
368
|
+
<a name="webhookVerification" class="tsd-anchor"></a>
|
|
369
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Verification</h3>
|
|
370
|
+
<div class="tsd-signature tsd-kind-icon">webhook<wbr>Verification<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
|
|
307
371
|
<aside class="tsd-sources">
|
|
308
372
|
<ul>
|
|
309
|
-
<li>Defined in datatypes.ts:
|
|
373
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L799">datatypes.ts:799</a></li>
|
|
310
374
|
</ul>
|
|
311
375
|
</aside>
|
|
312
376
|
<div class="tsd-comment tsd-typography">
|
|
313
377
|
<div class="lead">
|
|
314
|
-
<p>
|
|
378
|
+
<p>webhook verification module configuration or <code>null</code></p>
|
|
315
379
|
</div>
|
|
316
380
|
</div>
|
|
317
381
|
</section>
|
|
318
382
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
319
|
-
<a name="
|
|
320
|
-
<h3><span class="tsd-flag ts-flagOptional">Optional</span>
|
|
321
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
383
|
+
<a name="websocketTcpConverter" class="tsd-anchor"></a>
|
|
384
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> websocket<wbr>Tcp<wbr>Converter</h3>
|
|
385
|
+
<div class="tsd-signature tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
|
|
322
386
|
<aside class="tsd-sources">
|
|
323
387
|
<ul>
|
|
324
|
-
<li>Defined in datatypes.ts:
|
|
388
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L807">datatypes.ts:807</a></li>
|
|
325
389
|
</ul>
|
|
326
390
|
</aside>
|
|
327
391
|
<div class="tsd-comment tsd-typography">
|
|
328
392
|
<div class="lead">
|
|
329
|
-
<p>
|
|
393
|
+
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
|
330
394
|
</div>
|
|
331
395
|
</div>
|
|
332
396
|
</section>
|
|
@@ -354,52 +418,64 @@
|
|
|
354
418
|
</ul>
|
|
355
419
|
<ul class="current">
|
|
356
420
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
357
|
-
<a href="datatypes.
|
|
421
|
+
<a href="datatypes.HTTPSEdgeRoute.html" class="tsd-kind-icon">HTTPSEdge<wbr>Route</a>
|
|
358
422
|
<ul>
|
|
359
423
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
360
|
-
<a href="datatypes.
|
|
424
|
+
<a href="datatypes.HTTPSEdgeRoute.html#backend" class="tsd-kind-icon">backend</a>
|
|
425
|
+
</li>
|
|
426
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
427
|
+
<a href="datatypes.HTTPSEdgeRoute.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a>
|
|
428
|
+
</li>
|
|
429
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
430
|
+
<a href="datatypes.HTTPSEdgeRoute.html#compression" class="tsd-kind-icon">compression</a>
|
|
431
|
+
</li>
|
|
432
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
433
|
+
<a href="datatypes.HTTPSEdgeRoute.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
434
|
+
</li>
|
|
435
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
436
|
+
<a href="datatypes.HTTPSEdgeRoute.html#description" class="tsd-kind-icon">description</a>
|
|
361
437
|
</li>
|
|
362
438
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
363
|
-
<a href="datatypes.
|
|
439
|
+
<a href="datatypes.HTTPSEdgeRoute.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a>
|
|
364
440
|
</li>
|
|
365
441
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
366
|
-
<a href="datatypes.
|
|
442
|
+
<a href="datatypes.HTTPSEdgeRoute.html#id" class="tsd-kind-icon">id</a>
|
|
367
443
|
</li>
|
|
368
444
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
369
|
-
<a href="datatypes.
|
|
445
|
+
<a href="datatypes.HTTPSEdgeRoute.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
|
|
370
446
|
</li>
|
|
371
447
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
372
|
-
<a href="datatypes.
|
|
448
|
+
<a href="datatypes.HTTPSEdgeRoute.html#match" class="tsd-kind-icon">match</a>
|
|
373
449
|
</li>
|
|
374
450
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
375
|
-
<a href="datatypes.
|
|
451
|
+
<a href="datatypes.HTTPSEdgeRoute.html#matchType" class="tsd-kind-icon">match<wbr>Type</a>
|
|
376
452
|
</li>
|
|
377
453
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
378
|
-
<a href="datatypes.
|
|
454
|
+
<a href="datatypes.HTTPSEdgeRoute.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
379
455
|
</li>
|
|
380
456
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
381
|
-
<a href="datatypes.
|
|
457
|
+
<a href="datatypes.HTTPSEdgeRoute.html#oauth" class="tsd-kind-icon">oauth</a>
|
|
382
458
|
</li>
|
|
383
459
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
384
|
-
<a href="datatypes.
|
|
460
|
+
<a href="datatypes.HTTPSEdgeRoute.html#oidc" class="tsd-kind-icon">oidc</a>
|
|
385
461
|
</li>
|
|
386
462
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
387
|
-
<a href="datatypes.
|
|
463
|
+
<a href="datatypes.HTTPSEdgeRoute.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
|
|
388
464
|
</li>
|
|
389
465
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
390
|
-
<a href="datatypes.
|
|
466
|
+
<a href="datatypes.HTTPSEdgeRoute.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a>
|
|
391
467
|
</li>
|
|
392
468
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
393
|
-
<a href="datatypes.
|
|
469
|
+
<a href="datatypes.HTTPSEdgeRoute.html#saml" class="tsd-kind-icon">saml</a>
|
|
394
470
|
</li>
|
|
395
471
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
396
|
-
<a href="datatypes.
|
|
472
|
+
<a href="datatypes.HTTPSEdgeRoute.html#uri" class="tsd-kind-icon">uri</a>
|
|
397
473
|
</li>
|
|
398
474
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
399
|
-
<a href="datatypes.
|
|
475
|
+
<a href="datatypes.HTTPSEdgeRoute.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a>
|
|
400
476
|
</li>
|
|
401
477
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
402
|
-
<a href="datatypes.
|
|
478
|
+
<a href="datatypes.HTTPSEdgeRoute.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a>
|
|
403
479
|
</li>
|
|
404
480
|
</ul>
|
|
405
481
|
</li>
|