@ngrok/ngrok-api 0.9.0 → 0.11.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 +16 -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 +82 -28
- 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.BotUsers.html +352 -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.EdgeRoutePolicyModule.html +270 -0
- 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.EdgeRouteUserAgentFilterModule.html +270 -0
- 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.StaticBackends.html +360 -0
- package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TCPEdgePolicyModule.html +270 -0
- 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.TLSEdgePolicyModule.html +270 -0
- 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 +3 -3
- 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.BotUser.html +243 -0
- package/docs/interfaces/datatypes.BotUserCreate.html +186 -0
- package/docs/interfaces/datatypes.BotUserList.html +205 -0
- package/docs/interfaces/datatypes.BotUserUpdate.html +200 -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.EdgePolicyReplace.html +176 -0
- 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.EdgeRoutePolicyReplace.html +190 -0
- 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.EdgeRouteUserAgentFilterReplace.html +190 -0
- 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.EndpointAction.html +186 -0
- 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.EndpointPolicy.html +205 -0
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointRule.html +205 -0
- 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.EndpointUserAgentFilter.html +190 -0
- 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 +55 -22
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +51 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +52 -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 +17 -17
- 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 +19 -19
- 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.StaticBackend.html +281 -0
- package/docs/interfaces/datatypes.StaticBackendCreate.html +224 -0
- package/docs/interfaces/datatypes.StaticBackendList.html +205 -0
- package/docs/interfaces/datatypes.StaticBackendTLS.html +167 -0
- package/docs/interfaces/datatypes.StaticBackendUpdate.html +238 -0
- package/docs/interfaces/datatypes.TCPEdge.html +30 -11
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +26 -7
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +25 -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 +32 -13
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +28 -9
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +27 -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 +128 -0
- package/docs/modules/services.html +32 -0
- package/jest.config.js +2 -0
- package/lib/client.d.ts +17 -8
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +92 -119
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +539 -204
- 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 +254 -126
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +3613 -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 +4 -3
- package/src/client.ts +28 -33
- package/src/datatypes.ts +576 -207
- package/src/index.ts +2 -0
- package/src/services.ts +1136 -553
- package/src/util.ts +2 -0
- package/test/apikey.test.js +62 -63
|
@@ -96,10 +96,12 @@
|
|
|
96
96
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
97
97
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#oauth" class="tsd-kind-icon">oauth</a></li>
|
|
98
98
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#oidc" class="tsd-kind-icon">oidc</a></li>
|
|
99
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#policy" class="tsd-kind-icon">policy</a></li>
|
|
99
100
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
|
|
100
101
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
|
|
101
102
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#saml" class="tsd-kind-icon">saml</a></li>
|
|
102
103
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
104
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#userAgentFilter" class="tsd-kind-icon">user<wbr>Agent<wbr>Filter</a></li>
|
|
103
105
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a></li>
|
|
104
106
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a></li>
|
|
105
107
|
</ul>
|
|
@@ -115,7 +117,7 @@
|
|
|
115
117
|
<div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a></div>
|
|
116
118
|
<aside class="tsd-sources">
|
|
117
119
|
<ul>
|
|
118
|
-
<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/4214cc1/src/datatypes.ts#L1143">datatypes.ts:1143</a></li>
|
|
119
121
|
</ul>
|
|
120
122
|
</aside>
|
|
121
123
|
<div class="tsd-comment tsd-typography">
|
|
@@ -130,7 +132,7 @@
|
|
|
130
132
|
<div class="tsd-signature tsd-kind-icon">circuit<wbr>Breaker<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</a></div>
|
|
131
133
|
<aside class="tsd-sources">
|
|
132
134
|
<ul>
|
|
133
|
-
<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/4214cc1/src/datatypes.ts#L1147">datatypes.ts:1147</a></li>
|
|
134
136
|
</ul>
|
|
135
137
|
</aside>
|
|
136
138
|
<div class="tsd-comment tsd-typography">
|
|
@@ -145,7 +147,7 @@
|
|
|
145
147
|
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</a></div>
|
|
146
148
|
<aside class="tsd-sources">
|
|
147
149
|
<ul>
|
|
148
|
-
<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/4214cc1/src/datatypes.ts#L1149">datatypes.ts:1149</a></li>
|
|
149
151
|
</ul>
|
|
150
152
|
</aside>
|
|
151
153
|
<div class="tsd-comment tsd-typography">
|
|
@@ -157,10 +159,10 @@
|
|
|
157
159
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
158
160
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
159
161
|
<h3>created<wbr>At</h3>
|
|
160
|
-
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
|
162
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
161
163
|
<aside class="tsd-sources">
|
|
162
164
|
<ul>
|
|
163
|
-
<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/4214cc1/src/datatypes.ts#L1131">datatypes.ts:1131</a></li>
|
|
164
166
|
</ul>
|
|
165
167
|
</aside>
|
|
166
168
|
<div class="tsd-comment tsd-typography">
|
|
@@ -171,11 +173,11 @@
|
|
|
171
173
|
</section>
|
|
172
174
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
173
175
|
<a name="description" class="tsd-anchor"></a>
|
|
174
|
-
<h3>description</h3>
|
|
176
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
175
177
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
176
178
|
<aside class="tsd-sources">
|
|
177
179
|
<ul>
|
|
178
|
-
<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/4214cc1/src/datatypes.ts#L1139">datatypes.ts:1139</a></li>
|
|
179
181
|
</ul>
|
|
180
182
|
</aside>
|
|
181
183
|
<div class="tsd-comment tsd-typography">
|
|
@@ -190,7 +192,7 @@
|
|
|
190
192
|
<div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
191
193
|
<aside class="tsd-sources">
|
|
192
194
|
<ul>
|
|
193
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
195
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1127">datatypes.ts:1127</a></li>
|
|
194
196
|
</ul>
|
|
195
197
|
</aside>
|
|
196
198
|
<div class="tsd-comment tsd-typography">
|
|
@@ -205,7 +207,7 @@
|
|
|
205
207
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
206
208
|
<aside class="tsd-sources">
|
|
207
209
|
<ul>
|
|
208
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
210
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1129">datatypes.ts:1129</a></li>
|
|
209
211
|
</ul>
|
|
210
212
|
</aside>
|
|
211
213
|
<div class="tsd-comment tsd-typography">
|
|
@@ -220,7 +222,7 @@
|
|
|
220
222
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
|
|
221
223
|
<aside class="tsd-sources">
|
|
222
224
|
<ul>
|
|
223
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
225
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1145">datatypes.ts:1145</a></li>
|
|
224
226
|
</ul>
|
|
225
227
|
</aside>
|
|
226
228
|
<div class="tsd-comment tsd-typography">
|
|
@@ -235,7 +237,7 @@
|
|
|
235
237
|
<div class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
236
238
|
<aside class="tsd-sources">
|
|
237
239
|
<ul>
|
|
238
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
240
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1135">datatypes.ts:1135</a></li>
|
|
239
241
|
</ul>
|
|
240
242
|
</aside>
|
|
241
243
|
<div class="tsd-comment tsd-typography">
|
|
@@ -250,7 +252,7 @@
|
|
|
250
252
|
<div class="tsd-signature tsd-kind-icon">match<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
251
253
|
<aside class="tsd-sources">
|
|
252
254
|
<ul>
|
|
253
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
255
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1133">datatypes.ts:1133</a></li>
|
|
254
256
|
</ul>
|
|
255
257
|
</aside>
|
|
256
258
|
<div class="tsd-comment tsd-typography">
|
|
@@ -261,11 +263,11 @@
|
|
|
261
263
|
</section>
|
|
262
264
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
263
265
|
<a name="metadata" class="tsd-anchor"></a>
|
|
264
|
-
<h3>metadata</h3>
|
|
266
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
265
267
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
266
268
|
<aside class="tsd-sources">
|
|
267
269
|
<ul>
|
|
268
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
270
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1141">datatypes.ts:1141</a></li>
|
|
269
271
|
</ul>
|
|
270
272
|
</aside>
|
|
271
273
|
<div class="tsd-comment tsd-typography">
|
|
@@ -280,7 +282,7 @@
|
|
|
280
282
|
<div class="tsd-signature tsd-kind-icon">oauth<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
|
|
281
283
|
<aside class="tsd-sources">
|
|
282
284
|
<ul>
|
|
283
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
285
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1157">datatypes.ts:1157</a></li>
|
|
284
286
|
</ul>
|
|
285
287
|
</aside>
|
|
286
288
|
<div class="tsd-comment tsd-typography">
|
|
@@ -295,7 +297,7 @@
|
|
|
295
297
|
<div class="tsd-signature tsd-kind-icon">oidc<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOIDC.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
|
|
296
298
|
<aside class="tsd-sources">
|
|
297
299
|
<ul>
|
|
298
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
300
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1161">datatypes.ts:1161</a></li>
|
|
299
301
|
</ul>
|
|
300
302
|
</aside>
|
|
301
303
|
<div class="tsd-comment tsd-typography">
|
|
@@ -304,13 +306,28 @@
|
|
|
304
306
|
</div>
|
|
305
307
|
</div>
|
|
306
308
|
</section>
|
|
309
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
310
|
+
<a name="policy" class="tsd-anchor"></a>
|
|
311
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> policy</h3>
|
|
312
|
+
<div class="tsd-signature tsd-kind-icon">policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointPolicy</a></div>
|
|
313
|
+
<aside class="tsd-sources">
|
|
314
|
+
<ul>
|
|
315
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1166">datatypes.ts:1166</a></li>
|
|
316
|
+
</ul>
|
|
317
|
+
</aside>
|
|
318
|
+
<div class="tsd-comment tsd-typography">
|
|
319
|
+
<div class="lead">
|
|
320
|
+
<p>the traffic policy associated with this edge or null</p>
|
|
321
|
+
</div>
|
|
322
|
+
</div>
|
|
323
|
+
</section>
|
|
307
324
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
308
325
|
<a name="requestHeaders" class="tsd-anchor"></a>
|
|
309
326
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr>Headers</h3>
|
|
310
327
|
<div class="tsd-signature tsd-kind-icon">request<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRequestHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
|
|
311
328
|
<aside class="tsd-sources">
|
|
312
329
|
<ul>
|
|
313
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
330
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1151">datatypes.ts:1151</a></li>
|
|
314
331
|
</ul>
|
|
315
332
|
</aside>
|
|
316
333
|
<div class="tsd-comment tsd-typography">
|
|
@@ -325,7 +342,7 @@
|
|
|
325
342
|
<div class="tsd-signature tsd-kind-icon">response<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
|
|
326
343
|
<aside class="tsd-sources">
|
|
327
344
|
<ul>
|
|
328
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
345
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1153">datatypes.ts:1153</a></li>
|
|
329
346
|
</ul>
|
|
330
347
|
</aside>
|
|
331
348
|
<div class="tsd-comment tsd-typography">
|
|
@@ -340,7 +357,7 @@
|
|
|
340
357
|
<div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAML.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a></div>
|
|
341
358
|
<aside class="tsd-sources">
|
|
342
359
|
<ul>
|
|
343
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
360
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1159">datatypes.ts:1159</a></li>
|
|
344
361
|
</ul>
|
|
345
362
|
</aside>
|
|
346
363
|
<div class="tsd-comment tsd-typography">
|
|
@@ -355,7 +372,7 @@
|
|
|
355
372
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
356
373
|
<aside class="tsd-sources">
|
|
357
374
|
<ul>
|
|
358
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
375
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1137">datatypes.ts:1137</a></li>
|
|
359
376
|
</ul>
|
|
360
377
|
</aside>
|
|
361
378
|
<div class="tsd-comment tsd-typography">
|
|
@@ -364,13 +381,23 @@
|
|
|
364
381
|
</div>
|
|
365
382
|
</div>
|
|
366
383
|
</section>
|
|
384
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
385
|
+
<a name="userAgentFilter" class="tsd-anchor"></a>
|
|
386
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr>Agent<wbr>Filter</h3>
|
|
387
|
+
<div class="tsd-signature tsd-kind-icon">user<wbr>Agent<wbr>Filter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointUserAgentFilter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointUserAgentFilter</a></div>
|
|
388
|
+
<aside class="tsd-sources">
|
|
389
|
+
<ul>
|
|
390
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1164">datatypes.ts:1164</a></li>
|
|
391
|
+
</ul>
|
|
392
|
+
</aside>
|
|
393
|
+
</section>
|
|
367
394
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
368
395
|
<a name="webhookVerification" class="tsd-anchor"></a>
|
|
369
396
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Verification</h3>
|
|
370
397
|
<div class="tsd-signature tsd-kind-icon">webhook<wbr>Verification<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
|
|
371
398
|
<aside class="tsd-sources">
|
|
372
399
|
<ul>
|
|
373
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
400
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1155">datatypes.ts:1155</a></li>
|
|
374
401
|
</ul>
|
|
375
402
|
</aside>
|
|
376
403
|
<div class="tsd-comment tsd-typography">
|
|
@@ -385,7 +412,7 @@
|
|
|
385
412
|
<div class="tsd-signature tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
|
|
386
413
|
<aside class="tsd-sources">
|
|
387
414
|
<ul>
|
|
388
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
415
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1163">datatypes.ts:1163</a></li>
|
|
389
416
|
</ul>
|
|
390
417
|
</aside>
|
|
391
418
|
<div class="tsd-comment tsd-typography">
|
|
@@ -459,6 +486,9 @@
|
|
|
459
486
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
460
487
|
<a href="datatypes.HTTPSEdgeRoute.html#oidc" class="tsd-kind-icon">oidc</a>
|
|
461
488
|
</li>
|
|
489
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
490
|
+
<a href="datatypes.HTTPSEdgeRoute.html#policy" class="tsd-kind-icon">policy</a>
|
|
491
|
+
</li>
|
|
462
492
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
463
493
|
<a href="datatypes.HTTPSEdgeRoute.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
|
|
464
494
|
</li>
|
|
@@ -471,6 +501,9 @@
|
|
|
471
501
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
472
502
|
<a href="datatypes.HTTPSEdgeRoute.html#uri" class="tsd-kind-icon">uri</a>
|
|
473
503
|
</li>
|
|
504
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
505
|
+
<a href="datatypes.HTTPSEdgeRoute.html#userAgentFilter" class="tsd-kind-icon">user<wbr>Agent<wbr>Filter</a>
|
|
506
|
+
</li>
|
|
474
507
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
475
508
|
<a href="datatypes.HTTPSEdgeRoute.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a>
|
|
476
509
|
</li>
|
|
@@ -94,9 +94,11 @@
|
|
|
94
94
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
95
95
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#oauth" class="tsd-kind-icon">oauth</a></li>
|
|
96
96
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#oidc" class="tsd-kind-icon">oidc</a></li>
|
|
97
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#policy" class="tsd-kind-icon">policy</a></li>
|
|
97
98
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
|
|
98
99
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
|
|
99
100
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#saml" class="tsd-kind-icon">saml</a></li>
|
|
101
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#userAgentFilter" class="tsd-kind-icon">user<wbr>Agent<wbr>Filter</a></li>
|
|
100
102
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a></li>
|
|
101
103
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a></li>
|
|
102
104
|
</ul>
|
|
@@ -112,7 +114,7 @@
|
|
|
112
114
|
<div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackendMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackendMutate</a></div>
|
|
113
115
|
<aside class="tsd-sources">
|
|
114
116
|
<ul>
|
|
115
|
-
<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/4214cc1/src/datatypes.ts#L1059">datatypes.ts:1059</a></li>
|
|
116
118
|
</ul>
|
|
117
119
|
</aside>
|
|
118
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -127,7 +129,7 @@
|
|
|
127
129
|
<div class="tsd-signature tsd-kind-icon">circuit<wbr>Breaker<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</a></div>
|
|
128
130
|
<aside class="tsd-sources">
|
|
129
131
|
<ul>
|
|
130
|
-
<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/4214cc1/src/datatypes.ts#L1063">datatypes.ts:1063</a></li>
|
|
131
133
|
</ul>
|
|
132
134
|
</aside>
|
|
133
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -142,7 +144,7 @@
|
|
|
142
144
|
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</a></div>
|
|
143
145
|
<aside class="tsd-sources">
|
|
144
146
|
<ul>
|
|
145
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
147
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1065">datatypes.ts:1065</a></li>
|
|
146
148
|
</ul>
|
|
147
149
|
</aside>
|
|
148
150
|
<div class="tsd-comment tsd-typography">
|
|
@@ -153,11 +155,11 @@
|
|
|
153
155
|
</section>
|
|
154
156
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
155
157
|
<a name="description" class="tsd-anchor"></a>
|
|
156
|
-
<h3>description</h3>
|
|
158
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
157
159
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
158
160
|
<aside class="tsd-sources">
|
|
159
161
|
<ul>
|
|
160
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
162
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1055">datatypes.ts:1055</a></li>
|
|
161
163
|
</ul>
|
|
162
164
|
</aside>
|
|
163
165
|
<div class="tsd-comment tsd-typography">
|
|
@@ -172,7 +174,7 @@
|
|
|
172
174
|
<div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
173
175
|
<aside class="tsd-sources">
|
|
174
176
|
<ul>
|
|
175
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
177
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1049">datatypes.ts:1049</a></li>
|
|
176
178
|
</ul>
|
|
177
179
|
</aside>
|
|
178
180
|
<div class="tsd-comment tsd-typography">
|
|
@@ -187,7 +189,7 @@
|
|
|
187
189
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicyMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
|
|
188
190
|
<aside class="tsd-sources">
|
|
189
191
|
<ul>
|
|
190
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
192
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1061">datatypes.ts:1061</a></li>
|
|
191
193
|
</ul>
|
|
192
194
|
</aside>
|
|
193
195
|
<div class="tsd-comment tsd-typography">
|
|
@@ -202,7 +204,7 @@
|
|
|
202
204
|
<div class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
203
205
|
<aside class="tsd-sources">
|
|
204
206
|
<ul>
|
|
205
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
207
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1053">datatypes.ts:1053</a></li>
|
|
206
208
|
</ul>
|
|
207
209
|
</aside>
|
|
208
210
|
<div class="tsd-comment tsd-typography">
|
|
@@ -217,7 +219,7 @@
|
|
|
217
219
|
<div class="tsd-signature tsd-kind-icon">match<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
218
220
|
<aside class="tsd-sources">
|
|
219
221
|
<ul>
|
|
220
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
222
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1051">datatypes.ts:1051</a></li>
|
|
221
223
|
</ul>
|
|
222
224
|
</aside>
|
|
223
225
|
<div class="tsd-comment tsd-typography">
|
|
@@ -228,11 +230,11 @@
|
|
|
228
230
|
</section>
|
|
229
231
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
230
232
|
<a name="metadata" class="tsd-anchor"></a>
|
|
231
|
-
<h3>metadata</h3>
|
|
233
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
232
234
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
233
235
|
<aside class="tsd-sources">
|
|
234
236
|
<ul>
|
|
235
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
237
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1057">datatypes.ts:1057</a></li>
|
|
236
238
|
</ul>
|
|
237
239
|
</aside>
|
|
238
240
|
<div class="tsd-comment tsd-typography">
|
|
@@ -247,7 +249,7 @@
|
|
|
247
249
|
<div class="tsd-signature tsd-kind-icon">oauth<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
|
|
248
250
|
<aside class="tsd-sources">
|
|
249
251
|
<ul>
|
|
250
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
252
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1073">datatypes.ts:1073</a></li>
|
|
251
253
|
</ul>
|
|
252
254
|
</aside>
|
|
253
255
|
<div class="tsd-comment tsd-typography">
|
|
@@ -262,7 +264,7 @@
|
|
|
262
264
|
<div class="tsd-signature tsd-kind-icon">oidc<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOIDC.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
|
|
263
265
|
<aside class="tsd-sources">
|
|
264
266
|
<ul>
|
|
265
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
267
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1077">datatypes.ts:1077</a></li>
|
|
266
268
|
</ul>
|
|
267
269
|
</aside>
|
|
268
270
|
<div class="tsd-comment tsd-typography">
|
|
@@ -271,13 +273,28 @@
|
|
|
271
273
|
</div>
|
|
272
274
|
</div>
|
|
273
275
|
</section>
|
|
276
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
277
|
+
<a name="policy" class="tsd-anchor"></a>
|
|
278
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> policy</h3>
|
|
279
|
+
<div class="tsd-signature tsd-kind-icon">policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointPolicy</a></div>
|
|
280
|
+
<aside class="tsd-sources">
|
|
281
|
+
<ul>
|
|
282
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1082">datatypes.ts:1082</a></li>
|
|
283
|
+
</ul>
|
|
284
|
+
</aside>
|
|
285
|
+
<div class="tsd-comment tsd-typography">
|
|
286
|
+
<div class="lead">
|
|
287
|
+
<p>the traffic policy associated with this edge or null</p>
|
|
288
|
+
</div>
|
|
289
|
+
</div>
|
|
290
|
+
</section>
|
|
274
291
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
275
292
|
<a name="requestHeaders" class="tsd-anchor"></a>
|
|
276
293
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr>Headers</h3>
|
|
277
294
|
<div class="tsd-signature tsd-kind-icon">request<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRequestHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
|
|
278
295
|
<aside class="tsd-sources">
|
|
279
296
|
<ul>
|
|
280
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
297
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1067">datatypes.ts:1067</a></li>
|
|
281
298
|
</ul>
|
|
282
299
|
</aside>
|
|
283
300
|
<div class="tsd-comment tsd-typography">
|
|
@@ -292,7 +309,7 @@
|
|
|
292
309
|
<div class="tsd-signature tsd-kind-icon">response<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
|
|
293
310
|
<aside class="tsd-sources">
|
|
294
311
|
<ul>
|
|
295
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
312
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1069">datatypes.ts:1069</a></li>
|
|
296
313
|
</ul>
|
|
297
314
|
</aside>
|
|
298
315
|
<div class="tsd-comment tsd-typography">
|
|
@@ -307,7 +324,7 @@
|
|
|
307
324
|
<div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAMLMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLMutate</a></div>
|
|
308
325
|
<aside class="tsd-sources">
|
|
309
326
|
<ul>
|
|
310
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
327
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1075">datatypes.ts:1075</a></li>
|
|
311
328
|
</ul>
|
|
312
329
|
</aside>
|
|
313
330
|
<div class="tsd-comment tsd-typography">
|
|
@@ -316,13 +333,23 @@
|
|
|
316
333
|
</div>
|
|
317
334
|
</div>
|
|
318
335
|
</section>
|
|
336
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
337
|
+
<a name="userAgentFilter" class="tsd-anchor"></a>
|
|
338
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr>Agent<wbr>Filter</h3>
|
|
339
|
+
<div class="tsd-signature tsd-kind-icon">user<wbr>Agent<wbr>Filter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointUserAgentFilter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointUserAgentFilter</a></div>
|
|
340
|
+
<aside class="tsd-sources">
|
|
341
|
+
<ul>
|
|
342
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1080">datatypes.ts:1080</a></li>
|
|
343
|
+
</ul>
|
|
344
|
+
</aside>
|
|
345
|
+
</section>
|
|
319
346
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
320
347
|
<a name="webhookVerification" class="tsd-anchor"></a>
|
|
321
348
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Verification</h3>
|
|
322
349
|
<div class="tsd-signature tsd-kind-icon">webhook<wbr>Verification<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
|
|
323
350
|
<aside class="tsd-sources">
|
|
324
351
|
<ul>
|
|
325
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
352
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1071">datatypes.ts:1071</a></li>
|
|
326
353
|
</ul>
|
|
327
354
|
</aside>
|
|
328
355
|
<div class="tsd-comment tsd-typography">
|
|
@@ -337,7 +364,7 @@
|
|
|
337
364
|
<div class="tsd-signature tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
|
|
338
365
|
<aside class="tsd-sources">
|
|
339
366
|
<ul>
|
|
340
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
367
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1079">datatypes.ts:1079</a></li>
|
|
341
368
|
</ul>
|
|
342
369
|
</aside>
|
|
343
370
|
<div class="tsd-comment tsd-typography">
|
|
@@ -405,6 +432,9 @@
|
|
|
405
432
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
406
433
|
<a href="datatypes.HTTPSEdgeRouteCreate.html#oidc" class="tsd-kind-icon">oidc</a>
|
|
407
434
|
</li>
|
|
435
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
436
|
+
<a href="datatypes.HTTPSEdgeRouteCreate.html#policy" class="tsd-kind-icon">policy</a>
|
|
437
|
+
</li>
|
|
408
438
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
409
439
|
<a href="datatypes.HTTPSEdgeRouteCreate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
|
|
410
440
|
</li>
|
|
@@ -414,6 +444,9 @@
|
|
|
414
444
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
415
445
|
<a href="datatypes.HTTPSEdgeRouteCreate.html#saml" class="tsd-kind-icon">saml</a>
|
|
416
446
|
</li>
|
|
447
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
448
|
+
<a href="datatypes.HTTPSEdgeRouteCreate.html#userAgentFilter" class="tsd-kind-icon">user<wbr>Agent<wbr>Filter</a>
|
|
449
|
+
</li>
|
|
417
450
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
418
451
|
<a href="datatypes.HTTPSEdgeRouteCreate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a>
|
|
419
452
|
</li>
|