@ngrok/ngrok-api 0.9.0 → 0.10.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/.eslintignore +2 -0
- package/.eslintrc.js +2 -0
- package/.prettierrc.js +2 -0
- package/CHANGELOG.md +12 -3
- package/CODE_OF_CONDUCT.md +45 -0
- package/README.md +9 -3
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +54 -26
- package/docs/classes/services.APIKeys.html +20 -11
- package/docs/classes/services.AbuseReports.html +5 -5
- package/docs/classes/services.AgentIngresses.html +20 -11
- package/docs/classes/services.ApplicationSessions.html +288 -0
- package/docs/classes/services.ApplicationUsers.html +288 -0
- package/docs/classes/services.CertificateAuthorities.html +20 -11
- package/docs/classes/services.Credentials.html +21 -12
- 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.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +20 -11
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +20 -11
- package/docs/classes/services.EdgesTLS.html +20 -11
- package/docs/classes/services.Endpoints.html +15 -6
- package/docs/classes/services.EventDestinations.html +21 -12
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +20 -11
- package/docs/classes/services.FailoverBackends.html +20 -11
- package/docs/classes/services.HTTPResponseBackends.html +20 -11
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.IPPolicies.html +20 -11
- package/docs/classes/services.IPPolicyRules.html +20 -11
- package/docs/classes/services.IPRestrictions.html +20 -11
- package/docs/classes/services.ReservedAddrs.html +20 -11
- package/docs/classes/services.ReservedDomains.html +26 -17
- package/docs/classes/services.SSHCertificateAuthorities.html +20 -11
- package/docs/classes/services.SSHCredentials.html +20 -11
- package/docs/classes/services.SSHHostCertificates.html +20 -11
- package/docs/classes/services.SSHUserCertificates.html +20 -11
- package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TLSCertificates.html +20 -11
- package/docs/classes/services.TLSEdgeBackendModule.html +8 -8
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.TunnelGroupBackends.html +20 -11
- package/docs/classes/services.TunnelSessions.html +22 -13
- package/docs/classes/services.Tunnels.html +15 -6
- package/docs/classes/services.WeightedBackends.html +20 -11
- package/docs/index.html +8 -3
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +28 -9
- package/docs/interfaces/datatypes.APIKeyCreate.html +23 -4
- 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 +9 -9
- package/docs/interfaces/datatypes.AbuseReportCreate.html +3 -3
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +49 -11
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +224 -0
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCreate.html +24 -5
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +22 -3
- package/docs/interfaces/datatypes.ApplicationSession.html +357 -0
- package/docs/interfaces/datatypes.ApplicationSessionList.html +205 -0
- package/docs/interfaces/datatypes.ApplicationUser.html +338 -0
- package/docs/interfaces/datatypes.ApplicationUserList.html +205 -0
- package/docs/interfaces/datatypes.BrowserSession.html +205 -0
- package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +30 -11
- package/docs/interfaces/datatypes.CredentialCreate.html +25 -6
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +5 -5
- 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.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.Endpoint.html +19 -19
- 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.EndpointIPPolicy.html +7 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- 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 +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +12 -12
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +80 -4
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +218 -0
- 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.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +10 -10
- package/docs/interfaces/datatypes.EventDestinationCreate.html +6 -6
- 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 +10 -10
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +6 -6
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +22 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +224 -0
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +9 -9
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +11 -11
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +12 -12
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +22 -22
- 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 +8 -8
- package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
- 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 +11 -11
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.IdentityProvider.html +186 -0
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +224 -0
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +10 -10
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +15 -15
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +6 -6
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +18 -18
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +30 -11
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +19 -19
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +13 -13
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TCPEdge.html +11 -11
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.TLSCertificate.html +28 -28
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +8 -8
- 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 +13 -13
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +9 -9
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +8 -8
- package/docs/interfaces/datatypes.Tunnel.html +17 -17
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
- 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 +12 -12
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +262 -0
- package/docs/interfaces/datatypes.WeightedBackend.html +9 -9
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +64 -0
- package/docs/modules/services.html +8 -0
- package/jest.config.js +2 -0
- package/lib/client.d.ts +9 -7
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +89 -119
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +392 -201
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/datatypes.js +4 -3
- package/lib/datatypes.js.map +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +16 -28
- package/lib/index.js.map +1 -1
- package/lib/services.d.ts +164 -126
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +3294 -3356
- package/lib/services.js.map +1 -1
- package/lib/util.d.ts.map +1 -1
- package/lib/util.js +35 -34
- package/lib/util.js.map +1 -1
- package/package.json +3 -3
- package/src/client.ts +16 -32
- package/src/datatypes.ts +413 -204
- package/src/index.ts +2 -0
- package/src/services.ts +768 -519
- package/src/util.ts +2 -0
- package/test/apikey.test.js +62 -63
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1167">datatypes.ts:1167</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
</section>
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
110
110
|
<aside class="tsd-sources">
|
|
111
111
|
<ul>
|
|
112
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1168">datatypes.ts:1168</a></li>
|
|
113
113
|
</ul>
|
|
114
114
|
</aside>
|
|
115
115
|
</section>
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAMLMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLMutate</a></div>
|
|
120
120
|
<aside class="tsd-sources">
|
|
121
121
|
<ul>
|
|
122
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
122
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1169">datatypes.ts:1169</a></li>
|
|
123
123
|
</ul>
|
|
124
124
|
</aside>
|
|
125
125
|
</section>
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1155">datatypes.ts:1155</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
</section>
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
110
110
|
<aside class="tsd-sources">
|
|
111
111
|
<ul>
|
|
112
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1156">datatypes.ts:1156</a></li>
|
|
113
113
|
</ul>
|
|
114
114
|
</aside>
|
|
115
115
|
</section>
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
|
|
120
120
|
<aside class="tsd-sources">
|
|
121
121
|
<ul>
|
|
122
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
122
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1157">datatypes.ts:1157</a></li>
|
|
123
123
|
</ul>
|
|
124
124
|
</aside>
|
|
125
125
|
</section>
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1179">datatypes.ts:1179</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
</section>
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
110
110
|
<aside class="tsd-sources">
|
|
111
111
|
<ul>
|
|
112
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1180">datatypes.ts:1180</a></li>
|
|
113
113
|
</ul>
|
|
114
114
|
</aside>
|
|
115
115
|
</section>
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
|
|
120
120
|
<aside class="tsd-sources">
|
|
121
121
|
<ul>
|
|
122
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
122
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1181">datatypes.ts:1181</a></li>
|
|
123
123
|
</ul>
|
|
124
124
|
</aside>
|
|
125
125
|
</section>
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">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/9fd8564/src/datatypes.ts#L1114">datatypes.ts:1114</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
</section>
|
|
@@ -108,7 +108,7 @@
|
|
|
108
108
|
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTerminationAtEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTerminationAtEdge</a></div>
|
|
109
109
|
<aside class="tsd-sources">
|
|
110
110
|
<ul>
|
|
111
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
111
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1115">datatypes.ts:1115</a></li>
|
|
112
112
|
</ul>
|
|
113
113
|
</aside>
|
|
114
114
|
</section>
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">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/9fd8564/src/datatypes.ts#L1109">datatypes.ts:1109</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
</section>
|
|
@@ -108,7 +108,7 @@
|
|
|
108
108
|
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
|
|
109
109
|
<aside class="tsd-sources">
|
|
110
110
|
<ul>
|
|
111
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
111
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1110">datatypes.ts:1110</a></li>
|
|
112
112
|
</ul>
|
|
113
113
|
</aside>
|
|
114
114
|
</section>
|
|
@@ -105,11 +105,11 @@
|
|
|
105
105
|
<h2>Properties</h2>
|
|
106
106
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
107
107
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
108
|
-
<h3>created<wbr>At</h3>
|
|
109
|
-
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
|
108
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> created<wbr>At</h3>
|
|
109
|
+
<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
110
|
<aside class="tsd-sources">
|
|
111
111
|
<ul>
|
|
112
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1302">datatypes.ts:1302</a></li>
|
|
113
113
|
</ul>
|
|
114
114
|
</aside>
|
|
115
115
|
<div class="tsd-comment tsd-typography">
|
|
@@ -124,7 +124,7 @@
|
|
|
124
124
|
<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
125
|
<aside class="tsd-sources">
|
|
126
126
|
<ul>
|
|
127
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
127
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1316">datatypes.ts:1316</a></li>
|
|
128
128
|
</ul>
|
|
129
129
|
</aside>
|
|
130
130
|
<div class="tsd-comment tsd-typography">
|
|
@@ -139,7 +139,7 @@
|
|
|
139
139
|
<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
140
|
<aside class="tsd-sources">
|
|
141
141
|
<ul>
|
|
142
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
142
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1322">datatypes.ts:1322</a></li>
|
|
143
143
|
</ul>
|
|
144
144
|
</aside>
|
|
145
145
|
<div class="tsd-comment tsd-typography">
|
|
@@ -154,7 +154,7 @@
|
|
|
154
154
|
<div class="tsd-signature tsd-kind-icon">hostport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
155
155
|
<aside class="tsd-sources">
|
|
156
156
|
<ul>
|
|
157
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
157
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1310">datatypes.ts:1310</a></li>
|
|
158
158
|
</ul>
|
|
159
159
|
</aside>
|
|
160
160
|
<div class="tsd-comment tsd-typography">
|
|
@@ -169,7 +169,7 @@
|
|
|
169
169
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
170
170
|
<aside class="tsd-sources">
|
|
171
171
|
<ul>
|
|
172
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
172
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1298">datatypes.ts:1298</a></li>
|
|
173
173
|
</ul>
|
|
174
174
|
</aside>
|
|
175
175
|
<div class="tsd-comment tsd-typography">
|
|
@@ -180,11 +180,11 @@
|
|
|
180
180
|
</section>
|
|
181
181
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
182
182
|
<a name="metadata" class="tsd-anchor"></a>
|
|
183
|
-
<h3>metadata</h3>
|
|
183
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
184
184
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
185
185
|
<aside class="tsd-sources">
|
|
186
186
|
<ul>
|
|
187
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
187
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1314">datatypes.ts:1314</a></li>
|
|
188
188
|
</ul>
|
|
189
189
|
</aside>
|
|
190
190
|
<div class="tsd-comment tsd-typography">
|
|
@@ -199,7 +199,7 @@
|
|
|
199
199
|
<div class="tsd-signature tsd-kind-icon">proto<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
200
200
|
<aside class="tsd-sources">
|
|
201
201
|
<ul>
|
|
202
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
202
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1308">datatypes.ts:1308</a></li>
|
|
203
203
|
</ul>
|
|
204
204
|
</aside>
|
|
205
205
|
<div class="tsd-comment tsd-typography">
|
|
@@ -214,7 +214,7 @@
|
|
|
214
214
|
<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
215
|
<aside class="tsd-sources">
|
|
216
216
|
<ul>
|
|
217
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
217
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1306">datatypes.ts:1306</a></li>
|
|
218
218
|
</ul>
|
|
219
219
|
</aside>
|
|
220
220
|
<div class="tsd-comment tsd-typography">
|
|
@@ -225,11 +225,11 @@
|
|
|
225
225
|
</section>
|
|
226
226
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
227
227
|
<a name="region" class="tsd-anchor"></a>
|
|
228
|
-
<h3>region</h3>
|
|
228
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> region</h3>
|
|
229
229
|
<div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
230
230
|
<aside class="tsd-sources">
|
|
231
231
|
<ul>
|
|
232
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
232
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1300">datatypes.ts:1300</a></li>
|
|
233
233
|
</ul>
|
|
234
234
|
</aside>
|
|
235
235
|
<div class="tsd-comment tsd-typography">
|
|
@@ -244,7 +244,7 @@
|
|
|
244
244
|
<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
245
|
<aside class="tsd-sources">
|
|
246
246
|
<ul>
|
|
247
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
247
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1318">datatypes.ts:1318</a></li>
|
|
248
248
|
</ul>
|
|
249
249
|
</aside>
|
|
250
250
|
<div class="tsd-comment tsd-typography">
|
|
@@ -259,7 +259,7 @@
|
|
|
259
259
|
<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
260
|
<aside class="tsd-sources">
|
|
261
261
|
<ul>
|
|
262
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
262
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1320">datatypes.ts:1320</a></li>
|
|
263
263
|
</ul>
|
|
264
264
|
</aside>
|
|
265
265
|
<div class="tsd-comment tsd-typography">
|
|
@@ -274,7 +274,7 @@
|
|
|
274
274
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
275
275
|
<aside class="tsd-sources">
|
|
276
276
|
<ul>
|
|
277
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
277
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1312">datatypes.ts:1312</a></li>
|
|
278
278
|
</ul>
|
|
279
279
|
</aside>
|
|
280
280
|
<div class="tsd-comment tsd-typography">
|
|
@@ -285,11 +285,11 @@
|
|
|
285
285
|
</section>
|
|
286
286
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
287
287
|
<a name="updatedAt" class="tsd-anchor"></a>
|
|
288
|
-
<h3>updated<wbr>At</h3>
|
|
289
|
-
<div class="tsd-signature tsd-kind-icon">updated<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
|
288
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> updated<wbr>At</h3>
|
|
289
|
+
<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
290
|
<aside class="tsd-sources">
|
|
291
291
|
<ul>
|
|
292
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
292
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1304">datatypes.ts:1304</a></li>
|
|
293
293
|
</ul>
|
|
294
294
|
</aside>
|
|
295
295
|
<div class="tsd-comment tsd-typography">
|
|
@@ -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/9fd8564/src/datatypes.ts#L903">datatypes.ts:903</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/9fd8564/src/datatypes.ts#L901">datatypes.ts:901</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/9fd8564/src/datatypes.ts#L910">datatypes.ts:910</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/9fd8564/src/datatypes.ts#L908">datatypes.ts:908</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/9fd8564/src/datatypes.ts#L685">datatypes.ts:685</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/9fd8564/src/datatypes.ts#L695">datatypes.ts:695</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/9fd8564/src/datatypes.ts#L691">datatypes.ts:691</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/9fd8564/src/datatypes.ts#L689">datatypes.ts:689</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/9fd8564/src/datatypes.ts#L687">datatypes.ts:687</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/9fd8564/src/datatypes.ts#L693">datatypes.ts:693</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/9fd8564/src/datatypes.ts#L618">datatypes.ts:618</a></li>
|
|
101
101
|
</ul>
|
|
102
102
|
</aside>
|
|
103
103
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/9fd8564/src/datatypes.ts#L671">datatypes.ts:671</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,9 +113,14 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
|
|
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/9fd8564/src/datatypes.ts#L673">datatypes.ts:673</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
|
+
<div class="tsd-comment tsd-typography">
|
|
120
|
+
<div class="lead">
|
|
121
|
+
<p>list of all IP policies that will be used to check if a source IP is allowed access to the endpoint</p>
|
|
122
|
+
</div>
|
|
123
|
+
</div>
|
|
119
124
|
</section>
|
|
120
125
|
</section>
|
|
121
126
|
</div>
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/9fd8564/src/datatypes.ts#L678">datatypes.ts:678</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">ip<wbr>Policy<wbr>Ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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/9fd8564/src/datatypes.ts#L680">datatypes.ts:680</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">endpoints<span class="tsd-signature-symbol">:</span> <a href="datatypes.Endpoint.html" class="tsd-signature-type" data-tsd-kind="Interface">Endpoint</a><span class="tsd-signature-symbol">[]</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1327">datatypes.ts:1327</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1331">datatypes.ts:1331</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1329">datatypes.ts:1329</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
|
|
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/9fd8564/src/datatypes.ts#L625">datatypes.ts:625</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/9fd8564/src/datatypes.ts#L623">datatypes.ts:623</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">certificate<wbr>Authority<wbr>Ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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/9fd8564/src/datatypes.ts#L632">datatypes.ts:632</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/9fd8564/src/datatypes.ts#L630">datatypes.ts:630</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
<div class="tsd-signature tsd-kind-icon">auth<wbr>Check<wbr>Interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
104
104
|
<aside class="tsd-sources">
|
|
105
105
|
<ul>
|
|
106
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
106
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L712">datatypes.ts:712</a></li>
|
|
107
107
|
</ul>
|
|
108
108
|
</aside>
|
|
109
109
|
<div class="tsd-comment tsd-typography">
|
|
@@ -118,7 +118,7 @@
|
|
|
118
118
|
<div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
119
119
|
<aside class="tsd-sources">
|
|
120
120
|
<ul>
|
|
121
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
121
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L706">datatypes.ts:706</a></li>
|
|
122
122
|
</ul>
|
|
123
123
|
</aside>
|
|
124
124
|
<div class="tsd-comment tsd-typography">
|
|
@@ -133,7 +133,7 @@
|
|
|
133
133
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
134
134
|
<aside class="tsd-sources">
|
|
135
135
|
<ul>
|
|
136
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
136
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L700">datatypes.ts:700</a></li>
|
|
137
137
|
</ul>
|
|
138
138
|
</aside>
|
|
139
139
|
<div class="tsd-comment tsd-typography">
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
<div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
149
149
|
<aside class="tsd-sources">
|
|
150
150
|
<ul>
|
|
151
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
151
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L708">datatypes.ts:708</a></li>
|
|
152
152
|
</ul>
|
|
153
153
|
</aside>
|
|
154
154
|
<div class="tsd-comment tsd-typography">
|
|
@@ -163,7 +163,7 @@
|
|
|
163
163
|
<div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
164
164
|
<aside class="tsd-sources">
|
|
165
165
|
<ul>
|
|
166
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L710">datatypes.ts:710</a></li>
|
|
167
167
|
</ul>
|
|
168
168
|
</aside>
|
|
169
169
|
<div class="tsd-comment tsd-typography">
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
<div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
179
179
|
<aside class="tsd-sources">
|
|
180
180
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
181
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L704">datatypes.ts:704</a></li>
|
|
182
182
|
</ul>
|
|
183
183
|
</aside>
|
|
184
184
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
<div class="tsd-signature tsd-kind-icon">provider<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthProvider</a></div>
|
|
194
194
|
<aside class="tsd-sources">
|
|
195
195
|
<ul>
|
|
196
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
196
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L702">datatypes.ts:702</a></li>
|
|
197
197
|
</ul>
|
|
198
198
|
</aside>
|
|
199
199
|
<div class="tsd-comment tsd-typography">
|