@ngrok/ngrok-api 0.12.0 → 0.16.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/.github/workflows/ci.yml +28 -0
- package/CHANGELOG.md +14 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +76 -29
- package/docs/classes/services.APIKeys.html +6 -6
- package/docs/classes/services.AbuseReports.html +3 -3
- package/docs/classes/services.AgentIngresses.html +6 -6
- package/docs/classes/services.ApplicationSessions.html +4 -4
- package/docs/classes/services.ApplicationUsers.html +4 -4
- package/docs/classes/services.BotUsers.html +6 -6
- package/docs/classes/services.CertificateAuthorities.html +6 -6
- package/docs/classes/services.Credentials.html +6 -6
- package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
- package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
- package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
- package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +4 -4
- package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +6 -6
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +6 -6
- package/docs/classes/services.EdgesTLS.html +6 -6
- package/docs/classes/services.Endpoints.html +99 -3
- package/docs/classes/services.EventDestinations.html +6 -6
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +6 -6
- package/docs/classes/services.FailoverBackends.html +6 -6
- package/docs/classes/services.HTTPResponseBackends.html +6 -6
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.IPPolicies.html +6 -6
- package/docs/classes/services.IPPolicyRules.html +6 -6
- package/docs/classes/services.IPRestrictions.html +6 -6
- package/docs/classes/services.ReservedAddrs.html +6 -6
- package/docs/classes/services.ReservedDomains.html +8 -8
- package/docs/classes/services.SSHCertificateAuthorities.html +6 -6
- package/docs/classes/services.SSHCredentials.html +6 -6
- package/docs/classes/services.SSHHostCertificates.html +6 -6
- package/docs/classes/services.SSHUserCertificates.html +6 -6
- package/docs/classes/services.Secrets.html +359 -0
- package/docs/classes/services.StaticBackends.html +6 -6
- package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +4 -4
- package/docs/classes/services.TLSCertificates.html +6 -6
- package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +4 -4
- package/docs/classes/services.TunnelGroupBackends.html +6 -6
- package/docs/classes/services.TunnelSessions.html +6 -6
- package/docs/classes/services.Tunnels.html +3 -3
- package/docs/classes/services.Vaults.html +359 -0
- package/docs/classes/services.WeightedBackends.html +6 -6
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +7 -7
- package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
- 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 +10 -10
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
- package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
- package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
- package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
- package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUser.html +5 -5
- package/docs/interfaces/datatypes.BotUserCreate.html +2 -2
- package/docs/interfaces/datatypes.BotUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUserUpdate.html +3 -3
- package/docs/interfaces/datatypes.BrowserSession.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 +4 -4
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +2 -2
- package/docs/interfaces/datatypes.Endpoint.html +266 -15
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointCreate.html +276 -0
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- package/docs/interfaces/datatypes.EndpointListArgs.html +204 -0
- 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.EndpointOAuthAmazon.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
- 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 +2 -2
- package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointUpdate.html +276 -0
- package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +3 -3
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +3 -3
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- 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 +4 -4
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +5 -5
- package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +7 -7
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +21 -21
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +5 -5
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
- 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.IdentityProvider.html +2 -2
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +4 -4
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +12 -12
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -6
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- 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 +8 -8
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
- 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.Secret.html +338 -0
- package/docs/interfaces/datatypes.SecretCreate.html +243 -0
- package/docs/interfaces/datatypes.SecretList.html +200 -0
- package/docs/interfaces/datatypes.SecretUpdate.html +243 -0
- package/docs/interfaces/datatypes.StaticBackend.html +7 -7
- package/docs/interfaces/datatypes.StaticBackendCreate.html +4 -4
- package/docs/interfaces/datatypes.StaticBackendList.html +3 -3
- package/docs/interfaces/datatypes.StaticBackendTLS.html +1 -1
- package/docs/interfaces/datatypes.StaticBackendUpdate.html +5 -5
- package/docs/interfaces/datatypes.TCPEdge.html +9 -9
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +6 -6
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +7 -7
- 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 +11 -11
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +8 -8
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +9 -9
- package/docs/interfaces/datatypes.Tunnel.html +11 -11
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
- 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.UserAgent.html +6 -6
- package/docs/interfaces/datatypes.Vault.html +319 -0
- package/docs/interfaces/datatypes.VaultCreate.html +205 -0
- package/docs/interfaces/datatypes.VaultList.html +200 -0
- package/docs/interfaces/datatypes.VaultUpdate.html +224 -0
- package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +44 -0
- package/docs/modules/services.html +8 -0
- package/lib/client.d.ts +11 -0
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +6 -1
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +163 -4
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +72 -0
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +263 -25
- package/lib/services.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +23 -1
- package/src/datatypes.ts +174 -4
- package/src/services.ts +234 -2
|
@@ -83,19 +83,33 @@
|
|
|
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.Endpoint.html#bindings" class="tsd-kind-icon">bindings</a></li>
|
|
86
87
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#description" class="tsd-kind-icon">description</a></li>
|
|
87
89
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#domain" class="tsd-kind-icon">domain</a></li>
|
|
88
90
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#edge" class="tsd-kind-icon">edge</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#host" class="tsd-kind-icon">host</a></li>
|
|
89
92
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#hostport" class="tsd-kind-icon">hostport</a></li>
|
|
90
93
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#id" class="tsd-kind-icon">id</a></li>
|
|
91
94
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
95
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#name" class="tsd-kind-icon">name</a></li>
|
|
96
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#poolingEnabled" class="tsd-kind-icon">pooling<wbr>Enabled</a></li>
|
|
97
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#port" class="tsd-kind-icon">port</a></li>
|
|
98
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#principal" class="tsd-kind-icon">principal</a></li>
|
|
92
99
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#proto" class="tsd-kind-icon">proto</a></li>
|
|
93
100
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a></li>
|
|
94
101
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#region" class="tsd-kind-icon">region</a></li>
|
|
102
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#scheme" class="tsd-kind-icon">scheme</a></li>
|
|
95
103
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#tcpAddr" class="tsd-kind-icon">tcp<wbr>Addr</a></li>
|
|
104
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#trafficPolicy" class="tsd-kind-icon">traffic<wbr>Policy</a></li>
|
|
96
105
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#tunnel" class="tsd-kind-icon">tunnel</a></li>
|
|
106
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#tunnelSession" class="tsd-kind-icon">tunnel<wbr>Session</a></li>
|
|
97
107
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#type" class="tsd-kind-icon">type</a></li>
|
|
98
108
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a></li>
|
|
109
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#upstreamProtocol" class="tsd-kind-icon">upstream<wbr>Protocol</a></li>
|
|
110
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#upstreamUrl" class="tsd-kind-icon">upstream<wbr>Url</a></li>
|
|
111
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
112
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#url" class="tsd-kind-icon">url</a></li>
|
|
99
113
|
</ul>
|
|
100
114
|
</section>
|
|
101
115
|
</div>
|
|
@@ -103,13 +117,28 @@
|
|
|
103
117
|
</section>
|
|
104
118
|
<section class="tsd-panel-group tsd-member-group ">
|
|
105
119
|
<h2>Properties</h2>
|
|
120
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
121
|
+
<a name="bindings" class="tsd-anchor"></a>
|
|
122
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> bindings</h3>
|
|
123
|
+
<div class="tsd-signature tsd-kind-icon">bindings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
124
|
+
<aside class="tsd-sources">
|
|
125
|
+
<ul>
|
|
126
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1481">datatypes.ts:1481</a></li>
|
|
127
|
+
</ul>
|
|
128
|
+
</aside>
|
|
129
|
+
<div class="tsd-comment tsd-typography">
|
|
130
|
+
<div class="lead">
|
|
131
|
+
<p>the bindings associated with this endpoint</p>
|
|
132
|
+
</div>
|
|
133
|
+
</div>
|
|
134
|
+
</section>
|
|
106
135
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
107
136
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
108
137
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> created<wbr>At</h3>
|
|
109
138
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
110
139
|
<aside class="tsd-sources">
|
|
111
140
|
<ul>
|
|
112
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
141
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1444">datatypes.ts:1444</a></li>
|
|
113
142
|
</ul>
|
|
114
143
|
</aside>
|
|
115
144
|
<div class="tsd-comment tsd-typography">
|
|
@@ -118,13 +147,28 @@
|
|
|
118
147
|
</div>
|
|
119
148
|
</div>
|
|
120
149
|
</section>
|
|
150
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
151
|
+
<a name="description" class="tsd-anchor"></a>
|
|
152
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
153
|
+
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
154
|
+
<aside class="tsd-sources">
|
|
155
|
+
<ul>
|
|
156
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1461">datatypes.ts:1461</a></li>
|
|
157
|
+
</ul>
|
|
158
|
+
</aside>
|
|
159
|
+
<div class="tsd-comment tsd-typography">
|
|
160
|
+
<div class="lead">
|
|
161
|
+
<p>user-supplied description of the associated tunnel</p>
|
|
162
|
+
</div>
|
|
163
|
+
</div>
|
|
164
|
+
</section>
|
|
121
165
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
122
166
|
<a name="domain" class="tsd-anchor"></a>
|
|
123
167
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> domain</h3>
|
|
124
168
|
<div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
125
169
|
<aside class="tsd-sources">
|
|
126
170
|
<ul>
|
|
127
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
171
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1463">datatypes.ts:1463</a></li>
|
|
128
172
|
</ul>
|
|
129
173
|
</aside>
|
|
130
174
|
<div class="tsd-comment tsd-typography">
|
|
@@ -139,7 +183,7 @@
|
|
|
139
183
|
<div class="tsd-signature tsd-kind-icon">edge<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
140
184
|
<aside class="tsd-sources">
|
|
141
185
|
<ul>
|
|
142
|
-
<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/054c7e9/src/datatypes.ts#L1469">datatypes.ts:1469</a></li>
|
|
143
187
|
</ul>
|
|
144
188
|
</aside>
|
|
145
189
|
<div class="tsd-comment tsd-typography">
|
|
@@ -148,18 +192,28 @@
|
|
|
148
192
|
</div>
|
|
149
193
|
</div>
|
|
150
194
|
</section>
|
|
195
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
196
|
+
<a name="host" class="tsd-anchor"></a>
|
|
197
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> host</h3>
|
|
198
|
+
<div class="tsd-signature tsd-kind-icon">host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
199
|
+
<aside class="tsd-sources">
|
|
200
|
+
<ul>
|
|
201
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1454">datatypes.ts:1454</a></li>
|
|
202
|
+
</ul>
|
|
203
|
+
</aside>
|
|
204
|
+
</section>
|
|
151
205
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
152
206
|
<a name="hostport" class="tsd-anchor"></a>
|
|
153
207
|
<h3>hostport</h3>
|
|
154
208
|
<div class="tsd-signature tsd-kind-icon">hostport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
155
209
|
<aside class="tsd-sources">
|
|
156
210
|
<ul>
|
|
157
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
211
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1453">datatypes.ts:1453</a></li>
|
|
158
212
|
</ul>
|
|
159
213
|
</aside>
|
|
160
214
|
<div class="tsd-comment tsd-typography">
|
|
161
215
|
<div class="lead">
|
|
162
|
-
<p>hostport served by this endpoint (hostname:port)</p>
|
|
216
|
+
<p>hostport served by this endpoint (hostname:port) -> soon to be deprecated</p>
|
|
163
217
|
</div>
|
|
164
218
|
</div>
|
|
165
219
|
</section>
|
|
@@ -169,7 +223,7 @@
|
|
|
169
223
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
170
224
|
<aside class="tsd-sources">
|
|
171
225
|
<ul>
|
|
172
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
226
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1440">datatypes.ts:1440</a></li>
|
|
173
227
|
</ul>
|
|
174
228
|
</aside>
|
|
175
229
|
<div class="tsd-comment tsd-typography">
|
|
@@ -184,7 +238,7 @@
|
|
|
184
238
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
185
239
|
<aside class="tsd-sources">
|
|
186
240
|
<ul>
|
|
187
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
241
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1459">datatypes.ts:1459</a></li>
|
|
188
242
|
</ul>
|
|
189
243
|
</aside>
|
|
190
244
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,13 +247,68 @@
|
|
|
193
247
|
</div>
|
|
194
248
|
</div>
|
|
195
249
|
</section>
|
|
250
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
251
|
+
<a name="name" class="tsd-anchor"></a>
|
|
252
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
|
|
253
|
+
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
254
|
+
<aside class="tsd-sources">
|
|
255
|
+
<ul>
|
|
256
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1487">datatypes.ts:1487</a></li>
|
|
257
|
+
</ul>
|
|
258
|
+
</aside>
|
|
259
|
+
<div class="tsd-comment tsd-typography">
|
|
260
|
+
<div class="lead">
|
|
261
|
+
<p>user supplied name for the endpoint</p>
|
|
262
|
+
</div>
|
|
263
|
+
</div>
|
|
264
|
+
</section>
|
|
265
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
266
|
+
<a name="poolingEnabled" class="tsd-anchor"></a>
|
|
267
|
+
<h3>pooling<wbr>Enabled</h3>
|
|
268
|
+
<div class="tsd-signature tsd-kind-icon">pooling<wbr>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
269
|
+
<aside class="tsd-sources">
|
|
270
|
+
<ul>
|
|
271
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1489">datatypes.ts:1489</a></li>
|
|
272
|
+
</ul>
|
|
273
|
+
</aside>
|
|
274
|
+
<div class="tsd-comment tsd-typography">
|
|
275
|
+
<div class="lead">
|
|
276
|
+
<p>whether the endpoint allows pooling</p>
|
|
277
|
+
</div>
|
|
278
|
+
</div>
|
|
279
|
+
</section>
|
|
280
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
281
|
+
<a name="port" class="tsd-anchor"></a>
|
|
282
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> port</h3>
|
|
283
|
+
<div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
284
|
+
<aside class="tsd-sources">
|
|
285
|
+
<ul>
|
|
286
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1455">datatypes.ts:1455</a></li>
|
|
287
|
+
</ul>
|
|
288
|
+
</aside>
|
|
289
|
+
</section>
|
|
290
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
291
|
+
<a name="principal" class="tsd-anchor"></a>
|
|
292
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> principal</h3>
|
|
293
|
+
<div class="tsd-signature tsd-kind-icon">principal<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
294
|
+
<aside class="tsd-sources">
|
|
295
|
+
<ul>
|
|
296
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1477">datatypes.ts:1477</a></li>
|
|
297
|
+
</ul>
|
|
298
|
+
</aside>
|
|
299
|
+
<div class="tsd-comment tsd-typography">
|
|
300
|
+
<div class="lead">
|
|
301
|
+
<p>The ID of the owner (bot or user) that owns this endpoint</p>
|
|
302
|
+
</div>
|
|
303
|
+
</div>
|
|
304
|
+
</section>
|
|
196
305
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
197
306
|
<a name="proto" class="tsd-anchor"></a>
|
|
198
307
|
<h3>proto</h3>
|
|
199
308
|
<div class="tsd-signature tsd-kind-icon">proto<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
200
309
|
<aside class="tsd-sources">
|
|
201
310
|
<ul>
|
|
202
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
311
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1450">datatypes.ts:1450</a></li>
|
|
203
312
|
</ul>
|
|
204
313
|
</aside>
|
|
205
314
|
<div class="tsd-comment tsd-typography">
|
|
@@ -214,7 +323,7 @@
|
|
|
214
323
|
<div class="tsd-signature tsd-kind-icon">public<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
215
324
|
<aside class="tsd-sources">
|
|
216
325
|
<ul>
|
|
217
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
326
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1448">datatypes.ts:1448</a></li>
|
|
218
327
|
</ul>
|
|
219
328
|
</aside>
|
|
220
329
|
<div class="tsd-comment tsd-typography">
|
|
@@ -229,7 +338,7 @@
|
|
|
229
338
|
<div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
230
339
|
<aside class="tsd-sources">
|
|
231
340
|
<ul>
|
|
232
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
341
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1442">datatypes.ts:1442</a></li>
|
|
233
342
|
</ul>
|
|
234
343
|
</aside>
|
|
235
344
|
<div class="tsd-comment tsd-typography">
|
|
@@ -238,13 +347,23 @@
|
|
|
238
347
|
</div>
|
|
239
348
|
</div>
|
|
240
349
|
</section>
|
|
350
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
351
|
+
<a name="scheme" class="tsd-anchor"></a>
|
|
352
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> scheme</h3>
|
|
353
|
+
<div class="tsd-signature tsd-kind-icon">scheme<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
354
|
+
<aside class="tsd-sources">
|
|
355
|
+
<ul>
|
|
356
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1451">datatypes.ts:1451</a></li>
|
|
357
|
+
</ul>
|
|
358
|
+
</aside>
|
|
359
|
+
</section>
|
|
241
360
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
242
361
|
<a name="tcpAddr" class="tsd-anchor"></a>
|
|
243
362
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tcp<wbr>Addr</h3>
|
|
244
363
|
<div class="tsd-signature tsd-kind-icon">tcp<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
245
364
|
<aside class="tsd-sources">
|
|
246
365
|
<ul>
|
|
247
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
366
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1465">datatypes.ts:1465</a></li>
|
|
248
367
|
</ul>
|
|
249
368
|
</aside>
|
|
250
369
|
<div class="tsd-comment tsd-typography">
|
|
@@ -253,13 +372,28 @@
|
|
|
253
372
|
</div>
|
|
254
373
|
</div>
|
|
255
374
|
</section>
|
|
375
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
376
|
+
<a name="trafficPolicy" class="tsd-anchor"></a>
|
|
377
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> traffic<wbr>Policy</h3>
|
|
378
|
+
<div class="tsd-signature tsd-kind-icon">traffic<wbr>Policy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
379
|
+
<aside class="tsd-sources">
|
|
380
|
+
<ul>
|
|
381
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1479">datatypes.ts:1479</a></li>
|
|
382
|
+
</ul>
|
|
383
|
+
</aside>
|
|
384
|
+
<div class="tsd-comment tsd-typography">
|
|
385
|
+
<div class="lead">
|
|
386
|
+
<p>The traffic policy attached to this endpoint</p>
|
|
387
|
+
</div>
|
|
388
|
+
</div>
|
|
389
|
+
</section>
|
|
256
390
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
257
391
|
<a name="tunnel" class="tsd-anchor"></a>
|
|
258
392
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tunnel</h3>
|
|
259
393
|
<div class="tsd-signature tsd-kind-icon">tunnel<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
260
394
|
<aside class="tsd-sources">
|
|
261
395
|
<ul>
|
|
262
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
396
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1467">datatypes.ts:1467</a></li>
|
|
263
397
|
</ul>
|
|
264
398
|
</aside>
|
|
265
399
|
<div class="tsd-comment tsd-typography">
|
|
@@ -268,18 +402,33 @@
|
|
|
268
402
|
</div>
|
|
269
403
|
</div>
|
|
270
404
|
</section>
|
|
405
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
406
|
+
<a name="tunnelSession" class="tsd-anchor"></a>
|
|
407
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tunnel<wbr>Session</h3>
|
|
408
|
+
<div class="tsd-signature tsd-kind-icon">tunnel<wbr>Session<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
409
|
+
<aside class="tsd-sources">
|
|
410
|
+
<ul>
|
|
411
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1483">datatypes.ts:1483</a></li>
|
|
412
|
+
</ul>
|
|
413
|
+
</aside>
|
|
414
|
+
<div class="tsd-comment tsd-typography">
|
|
415
|
+
<div class="lead">
|
|
416
|
+
<p>The tunnel session of the agent for this endpoint</p>
|
|
417
|
+
</div>
|
|
418
|
+
</div>
|
|
419
|
+
</section>
|
|
271
420
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
272
421
|
<a name="type" class="tsd-anchor"></a>
|
|
273
422
|
<h3>type</h3>
|
|
274
423
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
275
424
|
<aside class="tsd-sources">
|
|
276
425
|
<ul>
|
|
277
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
426
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1457">datatypes.ts:1457</a></li>
|
|
278
427
|
</ul>
|
|
279
428
|
</aside>
|
|
280
429
|
<div class="tsd-comment tsd-typography">
|
|
281
430
|
<div class="lead">
|
|
282
|
-
<p>whether the endpoint is <code>ephemeral</code> (served directly by an agent-initiated tunnel) or <code>edge</code> (served by an edge)</p>
|
|
431
|
+
<p>whether the endpoint is <code>ephemeral</code> (served directly by an agent-initiated tunnel) or <code>edge</code> (served by an edge) or <code>cloud (represents a cloud endpoint)</code></p>
|
|
283
432
|
</div>
|
|
284
433
|
</div>
|
|
285
434
|
</section>
|
|
@@ -289,7 +438,7 @@
|
|
|
289
438
|
<div class="tsd-signature tsd-kind-icon">updated<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
290
439
|
<aside class="tsd-sources">
|
|
291
440
|
<ul>
|
|
292
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
441
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1446">datatypes.ts:1446</a></li>
|
|
293
442
|
</ul>
|
|
294
443
|
</aside>
|
|
295
444
|
<div class="tsd-comment tsd-typography">
|
|
@@ -298,6 +447,66 @@
|
|
|
298
447
|
</div>
|
|
299
448
|
</div>
|
|
300
449
|
</section>
|
|
450
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
451
|
+
<a name="upstreamProtocol" class="tsd-anchor"></a>
|
|
452
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> upstream<wbr>Protocol</h3>
|
|
453
|
+
<div class="tsd-signature tsd-kind-icon">upstream<wbr>Protocol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
454
|
+
<aside class="tsd-sources">
|
|
455
|
+
<ul>
|
|
456
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1473">datatypes.ts:1473</a></li>
|
|
457
|
+
</ul>
|
|
458
|
+
</aside>
|
|
459
|
+
<div class="tsd-comment tsd-typography">
|
|
460
|
+
<div class="lead">
|
|
461
|
+
<p>the protocol the agent uses to forward with</p>
|
|
462
|
+
</div>
|
|
463
|
+
</div>
|
|
464
|
+
</section>
|
|
465
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
466
|
+
<a name="upstreamUrl" class="tsd-anchor"></a>
|
|
467
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> upstream<wbr>Url</h3>
|
|
468
|
+
<div class="tsd-signature tsd-kind-icon">upstream<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
469
|
+
<aside class="tsd-sources">
|
|
470
|
+
<ul>
|
|
471
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1471">datatypes.ts:1471</a></li>
|
|
472
|
+
</ul>
|
|
473
|
+
</aside>
|
|
474
|
+
<div class="tsd-comment tsd-typography">
|
|
475
|
+
<div class="lead">
|
|
476
|
+
<p>the local address the tunnel forwards to</p>
|
|
477
|
+
</div>
|
|
478
|
+
</div>
|
|
479
|
+
</section>
|
|
480
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
481
|
+
<a name="uri" class="tsd-anchor"></a>
|
|
482
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> uri</h3>
|
|
483
|
+
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
484
|
+
<aside class="tsd-sources">
|
|
485
|
+
<ul>
|
|
486
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1485">datatypes.ts:1485</a></li>
|
|
487
|
+
</ul>
|
|
488
|
+
</aside>
|
|
489
|
+
<div class="tsd-comment tsd-typography">
|
|
490
|
+
<div class="lead">
|
|
491
|
+
<p>URI of the Cloud Endpoint API resource</p>
|
|
492
|
+
</div>
|
|
493
|
+
</div>
|
|
494
|
+
</section>
|
|
495
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
496
|
+
<a name="url" class="tsd-anchor"></a>
|
|
497
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3>
|
|
498
|
+
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
499
|
+
<aside class="tsd-sources">
|
|
500
|
+
<ul>
|
|
501
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1475">datatypes.ts:1475</a></li>
|
|
502
|
+
</ul>
|
|
503
|
+
</aside>
|
|
504
|
+
<div class="tsd-comment tsd-typography">
|
|
505
|
+
<div class="lead">
|
|
506
|
+
<p>the url of the endpoint</p>
|
|
507
|
+
</div>
|
|
508
|
+
</div>
|
|
509
|
+
</section>
|
|
301
510
|
</section>
|
|
302
511
|
</div>
|
|
303
512
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
@@ -324,15 +533,24 @@
|
|
|
324
533
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
325
534
|
<a href="datatypes.Endpoint.html" class="tsd-kind-icon">Endpoint</a>
|
|
326
535
|
<ul>
|
|
536
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
537
|
+
<a href="datatypes.Endpoint.html#bindings" class="tsd-kind-icon">bindings</a>
|
|
538
|
+
</li>
|
|
327
539
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
328
540
|
<a href="datatypes.Endpoint.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
329
541
|
</li>
|
|
542
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
543
|
+
<a href="datatypes.Endpoint.html#description" class="tsd-kind-icon">description</a>
|
|
544
|
+
</li>
|
|
330
545
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
331
546
|
<a href="datatypes.Endpoint.html#domain" class="tsd-kind-icon">domain</a>
|
|
332
547
|
</li>
|
|
333
548
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
334
549
|
<a href="datatypes.Endpoint.html#edge" class="tsd-kind-icon">edge</a>
|
|
335
550
|
</li>
|
|
551
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
552
|
+
<a href="datatypes.Endpoint.html#host" class="tsd-kind-icon">host</a>
|
|
553
|
+
</li>
|
|
336
554
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
337
555
|
<a href="datatypes.Endpoint.html#hostport" class="tsd-kind-icon">hostport</a>
|
|
338
556
|
</li>
|
|
@@ -342,6 +560,18 @@
|
|
|
342
560
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
343
561
|
<a href="datatypes.Endpoint.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
344
562
|
</li>
|
|
563
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
564
|
+
<a href="datatypes.Endpoint.html#name" class="tsd-kind-icon">name</a>
|
|
565
|
+
</li>
|
|
566
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
567
|
+
<a href="datatypes.Endpoint.html#poolingEnabled" class="tsd-kind-icon">pooling<wbr>Enabled</a>
|
|
568
|
+
</li>
|
|
569
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
570
|
+
<a href="datatypes.Endpoint.html#port" class="tsd-kind-icon">port</a>
|
|
571
|
+
</li>
|
|
572
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
573
|
+
<a href="datatypes.Endpoint.html#principal" class="tsd-kind-icon">principal</a>
|
|
574
|
+
</li>
|
|
345
575
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
346
576
|
<a href="datatypes.Endpoint.html#proto" class="tsd-kind-icon">proto</a>
|
|
347
577
|
</li>
|
|
@@ -351,18 +581,39 @@
|
|
|
351
581
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
352
582
|
<a href="datatypes.Endpoint.html#region" class="tsd-kind-icon">region</a>
|
|
353
583
|
</li>
|
|
584
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
585
|
+
<a href="datatypes.Endpoint.html#scheme" class="tsd-kind-icon">scheme</a>
|
|
586
|
+
</li>
|
|
354
587
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
355
588
|
<a href="datatypes.Endpoint.html#tcpAddr" class="tsd-kind-icon">tcp<wbr>Addr</a>
|
|
356
589
|
</li>
|
|
590
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
591
|
+
<a href="datatypes.Endpoint.html#trafficPolicy" class="tsd-kind-icon">traffic<wbr>Policy</a>
|
|
592
|
+
</li>
|
|
357
593
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
358
594
|
<a href="datatypes.Endpoint.html#tunnel" class="tsd-kind-icon">tunnel</a>
|
|
359
595
|
</li>
|
|
596
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
597
|
+
<a href="datatypes.Endpoint.html#tunnelSession" class="tsd-kind-icon">tunnel<wbr>Session</a>
|
|
598
|
+
</li>
|
|
360
599
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
361
600
|
<a href="datatypes.Endpoint.html#type" class="tsd-kind-icon">type</a>
|
|
362
601
|
</li>
|
|
363
602
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
364
603
|
<a href="datatypes.Endpoint.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a>
|
|
365
604
|
</li>
|
|
605
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
606
|
+
<a href="datatypes.Endpoint.html#upstreamProtocol" class="tsd-kind-icon">upstream<wbr>Protocol</a>
|
|
607
|
+
</li>
|
|
608
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
609
|
+
<a href="datatypes.Endpoint.html#upstreamUrl" class="tsd-kind-icon">upstream<wbr>Url</a>
|
|
610
|
+
</li>
|
|
611
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
612
|
+
<a href="datatypes.Endpoint.html#uri" class="tsd-kind-icon">uri</a>
|
|
613
|
+
</li>
|
|
614
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
615
|
+
<a href="datatypes.Endpoint.html#url" class="tsd-kind-icon">url</a>
|
|
616
|
+
</li>
|
|
366
617
|
</ul>
|
|
367
618
|
</li>
|
|
368
619
|
</ul>
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L994">datatypes.ts:994</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L992">datatypes.ts:992</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">backend<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1001">datatypes.ts:1001</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L999">datatypes.ts:999</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
103
103
|
<aside class="tsd-sources">
|
|
104
104
|
<ul>
|
|
105
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
105
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L776">datatypes.ts:776</a></li>
|
|
106
106
|
</ul>
|
|
107
107
|
</aside>
|
|
108
108
|
<div class="tsd-comment tsd-typography">
|
|
@@ -117,7 +117,7 @@
|
|
|
117
117
|
<div class="tsd-signature tsd-kind-icon">error<wbr>Threshold<wbr>Percentage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
118
118
|
<aside class="tsd-sources">
|
|
119
119
|
<ul>
|
|
120
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
120
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L786">datatypes.ts:786</a></li>
|
|
121
121
|
</ul>
|
|
122
122
|
</aside>
|
|
123
123
|
<div class="tsd-comment tsd-typography">
|
|
@@ -132,7 +132,7 @@
|
|
|
132
132
|
<div class="tsd-signature tsd-kind-icon">num<wbr>Buckets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
133
133
|
<aside class="tsd-sources">
|
|
134
134
|
<ul>
|
|
135
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
135
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L782">datatypes.ts:782</a></li>
|
|
136
136
|
</ul>
|
|
137
137
|
</aside>
|
|
138
138
|
<div class="tsd-comment tsd-typography">
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
<div class="tsd-signature tsd-kind-icon">rolling<wbr>Window<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
148
148
|
<aside class="tsd-sources">
|
|
149
149
|
<ul>
|
|
150
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
150
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L780">datatypes.ts:780</a></li>
|
|
151
151
|
</ul>
|
|
152
152
|
</aside>
|
|
153
153
|
<div class="tsd-comment tsd-typography">
|
|
@@ -162,7 +162,7 @@
|
|
|
162
162
|
<div class="tsd-signature tsd-kind-icon">tripped<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
163
163
|
<aside class="tsd-sources">
|
|
164
164
|
<ul>
|
|
165
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
165
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L778">datatypes.ts:778</a></li>
|
|
166
166
|
</ul>
|
|
167
167
|
</aside>
|
|
168
168
|
<div class="tsd-comment tsd-typography">
|
|
@@ -177,7 +177,7 @@
|
|
|
177
177
|
<div class="tsd-signature tsd-kind-icon">volume<wbr>Threshold<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
178
178
|
<aside class="tsd-sources">
|
|
179
179
|
<ul>
|
|
180
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
180
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L784">datatypes.ts:784</a></li>
|
|
181
181
|
</ul>
|
|
182
182
|
</aside>
|
|
183
183
|
<div class="tsd-comment tsd-typography">
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
98
98
|
<aside class="tsd-sources">
|
|
99
99
|
<ul>
|
|
100
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
100
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L709">datatypes.ts:709</a></li>
|
|
101
101
|
</ul>
|
|
102
102
|
</aside>
|
|
103
103
|
<div class="tsd-comment tsd-typography">
|