@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
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">authority<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/4214cc1/src/datatypes.ts#L1952">datatypes.ts:1952</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">private<wbr>Key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L1954">datatypes.ts:1954</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">provisioning<wbr>Job<span class="tsd-signature-symbol">:</span> <a href="datatypes.ReservedDomainCertJob.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertJob</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/4214cc1/src/datatypes.ts#L1961">datatypes.ts:1961</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -110,10 +110,10 @@
|
|
|
110
110
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
111
111
|
<a name="renewsAt" class="tsd-anchor"></a>
|
|
112
112
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> renews<wbr>At</h3>
|
|
113
|
-
<div class="tsd-signature tsd-kind-icon">renews<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
|
113
|
+
<div class="tsd-signature tsd-kind-icon">renews<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</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/4214cc1/src/datatypes.ts#L1959">datatypes.ts:1959</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -86,8 +86,8 @@
|
|
|
86
86
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#certificateId" class="tsd-kind-icon">certificate<wbr>Id</a></li>
|
|
87
87
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a></li>
|
|
88
88
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#description" class="tsd-kind-icon">description</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#domain" class="tsd-kind-icon">domain</a></li>
|
|
89
90
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
90
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#name" class="tsd-kind-icon">name</a></li>
|
|
91
91
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#region" class="tsd-kind-icon">region</a></li>
|
|
92
92
|
</ul>
|
|
93
93
|
</section>
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L1897">datatypes.ts:1897</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">certificate<wbr>Management<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.ReservedDomainCertPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertPolicy</a></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/4214cc1/src/datatypes.ts#L1899">datatypes.ts:1899</a></li>
|
|
121
121
|
</ul>
|
|
122
122
|
</aside>
|
|
123
123
|
<div class="tsd-comment tsd-typography">
|
|
@@ -128,11 +128,11 @@
|
|
|
128
128
|
</section>
|
|
129
129
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
130
130
|
<a name="description" class="tsd-anchor"></a>
|
|
131
|
-
<h3>description</h3>
|
|
131
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
132
132
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L1893">datatypes.ts:1893</a></li>
|
|
136
136
|
</ul>
|
|
137
137
|
</aside>
|
|
138
138
|
<div class="tsd-comment tsd-typography">
|
|
@@ -142,32 +142,32 @@
|
|
|
142
142
|
</div>
|
|
143
143
|
</section>
|
|
144
144
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
145
|
-
<a name="
|
|
146
|
-
<h3>
|
|
147
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
145
|
+
<a name="domain" class="tsd-anchor"></a>
|
|
146
|
+
<h3>domain</h3>
|
|
147
|
+
<div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L1889">datatypes.ts:1889</a></li>
|
|
151
151
|
</ul>
|
|
152
152
|
</aside>
|
|
153
153
|
<div class="tsd-comment tsd-typography">
|
|
154
154
|
<div class="lead">
|
|
155
|
-
<p>
|
|
155
|
+
<p>hostname of the reserved domain</p>
|
|
156
156
|
</div>
|
|
157
157
|
</div>
|
|
158
158
|
</section>
|
|
159
159
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
160
|
-
<a name="
|
|
161
|
-
<h3>
|
|
162
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
160
|
+
<a name="metadata" class="tsd-anchor"></a>
|
|
161
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
162
|
+
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L1895">datatypes.ts:1895</a></li>
|
|
166
166
|
</ul>
|
|
167
167
|
</aside>
|
|
168
168
|
<div class="tsd-comment tsd-typography">
|
|
169
169
|
<div class="lead">
|
|
170
|
-
<p>
|
|
170
|
+
<p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
|
|
171
171
|
</div>
|
|
172
172
|
</div>
|
|
173
173
|
</section>
|
|
@@ -177,12 +177,12 @@
|
|
|
177
177
|
<div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L1891">datatypes.ts:1891</a></li>
|
|
181
181
|
</ul>
|
|
182
182
|
</aside>
|
|
183
183
|
<div class="tsd-comment tsd-typography">
|
|
184
184
|
<div class="lead">
|
|
185
|
-
<p>
|
|
185
|
+
<p>deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)</p>
|
|
186
186
|
</div>
|
|
187
187
|
</div>
|
|
188
188
|
</section>
|
|
@@ -222,10 +222,10 @@
|
|
|
222
222
|
<a href="datatypes.ReservedDomainCreate.html#description" class="tsd-kind-icon">description</a>
|
|
223
223
|
</li>
|
|
224
224
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
225
|
-
<a href="datatypes.ReservedDomainCreate.html#
|
|
225
|
+
<a href="datatypes.ReservedDomainCreate.html#domain" class="tsd-kind-icon">domain</a>
|
|
226
226
|
</li>
|
|
227
227
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
228
|
-
<a href="datatypes.ReservedDomainCreate.html#
|
|
228
|
+
<a href="datatypes.ReservedDomainCreate.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
229
229
|
</li>
|
|
230
230
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
231
231
|
<a href="datatypes.ReservedDomainCreate.html#region" class="tsd-kind-icon">region</a>
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<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>
|
|
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/4214cc1/src/datatypes.ts#L1947">datatypes.ts:1947</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">reserved<wbr>Domains<span class="tsd-signature-symbol">:</span> <a href="datatypes.ReservedDomain.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomain</a><span class="tsd-signature-symbol">[]</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/4214cc1/src/datatypes.ts#L1943">datatypes.ts:1943</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/4214cc1/src/datatypes.ts#L1945">datatypes.ts:1945</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
102
|
<aside class="tsd-sources">
|
|
103
103
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
104
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1909">datatypes.ts:1909</a></li>
|
|
105
105
|
</ul>
|
|
106
106
|
</aside>
|
|
107
107
|
<div class="tsd-comment tsd-typography">
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Management<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.ReservedDomainCertPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertPolicy</a></div>
|
|
117
117
|
<aside class="tsd-sources">
|
|
118
118
|
<ul>
|
|
119
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
119
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1911">datatypes.ts:1911</a></li>
|
|
120
120
|
</ul>
|
|
121
121
|
</aside>
|
|
122
122
|
<div class="tsd-comment tsd-typography">
|
|
@@ -131,7 +131,7 @@
|
|
|
131
131
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
132
132
|
<aside class="tsd-sources">
|
|
133
133
|
<ul>
|
|
134
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
134
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1905">datatypes.ts:1905</a></li>
|
|
135
135
|
</ul>
|
|
136
136
|
</aside>
|
|
137
137
|
<div class="tsd-comment tsd-typography">
|
|
@@ -146,7 +146,7 @@
|
|
|
146
146
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
147
147
|
<aside class="tsd-sources">
|
|
148
148
|
<ul>
|
|
149
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
149
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1903">datatypes.ts:1903</a></li>
|
|
150
150
|
</ul>
|
|
151
151
|
</aside>
|
|
152
152
|
</section>
|
|
@@ -156,7 +156,7 @@
|
|
|
156
156
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
157
157
|
<aside class="tsd-sources">
|
|
158
158
|
<ul>
|
|
159
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
159
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1907">datatypes.ts:1907</a></li>
|
|
160
160
|
</ul>
|
|
161
161
|
</aside>
|
|
162
162
|
<div class="tsd-comment tsd-typography">
|
|
@@ -100,10 +100,10 @@
|
|
|
100
100
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
101
101
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
102
102
|
<h3>created<wbr>At</h3>
|
|
103
|
-
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
|
103
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</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/4214cc1/src/datatypes.ts#L2002">datatypes.ts:2002</a></li>
|
|
107
107
|
</ul>
|
|
108
108
|
</aside>
|
|
109
109
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,11 +114,11 @@
|
|
|
114
114
|
</section>
|
|
115
115
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
116
116
|
<a name="description" class="tsd-anchor"></a>
|
|
117
|
-
<h3>description</h3>
|
|
117
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
118
118
|
<div class="tsd-signature tsd-kind-icon">description<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/4214cc1/src/datatypes.ts#L2004">datatypes.ts:2004</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">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L1998">datatypes.ts:1998</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">key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L2010">datatypes.ts:2010</a></li>
|
|
152
152
|
</ul>
|
|
153
153
|
</aside>
|
|
154
154
|
<div class="tsd-comment tsd-typography">
|
|
@@ -159,11 +159,11 @@
|
|
|
159
159
|
</section>
|
|
160
160
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
161
161
|
<a name="metadata" class="tsd-anchor"></a>
|
|
162
|
-
<h3>metadata</h3>
|
|
162
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
163
163
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L2006">datatypes.ts:2006</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">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/4214cc1/src/datatypes.ts#L2008">datatypes.ts:2008</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">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></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/4214cc1/src/datatypes.ts#L2000">datatypes.ts:2000</a></li>
|
|
197
197
|
</ul>
|
|
198
198
|
</aside>
|
|
199
199
|
<div class="tsd-comment tsd-typography">
|
|
@@ -97,11 +97,11 @@
|
|
|
97
97
|
<h2>Properties</h2>
|
|
98
98
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
99
99
|
<a name="description" class="tsd-anchor"></a>
|
|
100
|
-
<h3>description</h3>
|
|
100
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
101
101
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
102
|
<aside class="tsd-sources">
|
|
103
103
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
104
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1977">datatypes.ts:1977</a></li>
|
|
105
105
|
</ul>
|
|
106
106
|
</aside>
|
|
107
107
|
<div class="tsd-comment tsd-typography">
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
<div class="tsd-signature tsd-kind-icon">elliptic<wbr>Curve<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
117
117
|
<aside class="tsd-sources">
|
|
118
118
|
<ul>
|
|
119
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
119
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1983">datatypes.ts:1983</a></li>
|
|
120
120
|
</ul>
|
|
121
121
|
</aside>
|
|
122
122
|
<div class="tsd-comment tsd-typography">
|
|
@@ -131,7 +131,7 @@
|
|
|
131
131
|
<div class="tsd-signature tsd-kind-icon">key<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
132
132
|
<aside class="tsd-sources">
|
|
133
133
|
<ul>
|
|
134
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
134
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1985">datatypes.ts:1985</a></li>
|
|
135
135
|
</ul>
|
|
136
136
|
</aside>
|
|
137
137
|
<div class="tsd-comment tsd-typography">
|
|
@@ -142,11 +142,11 @@
|
|
|
142
142
|
</section>
|
|
143
143
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
144
144
|
<a name="metadata" class="tsd-anchor"></a>
|
|
145
|
-
<h3>metadata</h3>
|
|
145
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
146
146
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
147
147
|
<aside class="tsd-sources">
|
|
148
148
|
<ul>
|
|
149
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
149
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1979">datatypes.ts:1979</a></li>
|
|
150
150
|
</ul>
|
|
151
151
|
</aside>
|
|
152
152
|
<div class="tsd-comment tsd-typography">
|
|
@@ -161,7 +161,7 @@
|
|
|
161
161
|
<div class="tsd-signature tsd-kind-icon">private<wbr>Key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
162
162
|
<aside class="tsd-sources">
|
|
163
163
|
<ul>
|
|
164
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
164
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1981">datatypes.ts:1981</a></li>
|
|
165
165
|
</ul>
|
|
166
166
|
</aside>
|
|
167
167
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<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>
|
|
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/4214cc1/src/datatypes.ts#L2019">datatypes.ts:2019</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">ssh<wbr>Certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="datatypes.SSHCertificateAuthority.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCertificateAuthority</a><span class="tsd-signature-symbol">[]</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/4214cc1/src/datatypes.ts#L2015">datatypes.ts:2015</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/4214cc1/src/datatypes.ts#L2017">datatypes.ts:2017</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">description<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/4214cc1/src/datatypes.ts#L1991">datatypes.ts:1991</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">id<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/4214cc1/src/datatypes.ts#L1989">datatypes.ts:1989</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
</section>
|
|
@@ -124,7 +124,7 @@
|
|
|
124
124
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></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/4214cc1/src/datatypes.ts#L1993">datatypes.ts:1993</a></li>
|
|
128
128
|
</ul>
|
|
129
129
|
</aside>
|
|
130
130
|
<div class="tsd-comment tsd-typography">
|
|
@@ -88,6 +88,7 @@
|
|
|
88
88
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#description" class="tsd-kind-icon">description</a></li>
|
|
89
89
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#id" class="tsd-kind-icon">id</a></li>
|
|
90
90
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a></li>
|
|
91
92
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
|
|
92
93
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
93
94
|
</ul>
|
|
@@ -103,22 +104,22 @@
|
|
|
103
104
|
<div class="tsd-signature tsd-kind-icon">acl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
104
105
|
<aside class="tsd-sources">
|
|
105
106
|
<ul>
|
|
106
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
107
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2059">datatypes.ts:2059</a></li>
|
|
107
108
|
</ul>
|
|
108
109
|
</aside>
|
|
109
110
|
<div class="tsd-comment tsd-typography">
|
|
110
111
|
<div class="lead">
|
|
111
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and
|
|
112
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
112
113
|
</div>
|
|
113
114
|
</div>
|
|
114
115
|
</section>
|
|
115
116
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
116
117
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
117
118
|
<h3>created<wbr>At</h3>
|
|
118
|
-
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
|
119
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
119
120
|
<aside class="tsd-sources">
|
|
120
121
|
<ul>
|
|
121
|
-
<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/4214cc1/src/datatypes.ts#L2051">datatypes.ts:2051</a></li>
|
|
122
123
|
</ul>
|
|
123
124
|
</aside>
|
|
124
125
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,11 +130,11 @@
|
|
|
129
130
|
</section>
|
|
130
131
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
131
132
|
<a name="description" class="tsd-anchor"></a>
|
|
132
|
-
<h3>description</h3>
|
|
133
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
133
134
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
134
135
|
<aside class="tsd-sources">
|
|
135
136
|
<ul>
|
|
136
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
137
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2053">datatypes.ts:2053</a></li>
|
|
137
138
|
</ul>
|
|
138
139
|
</aside>
|
|
139
140
|
<div class="tsd-comment tsd-typography">
|
|
@@ -148,7 +149,7 @@
|
|
|
148
149
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
149
150
|
<aside class="tsd-sources">
|
|
150
151
|
<ul>
|
|
151
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
152
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2047">datatypes.ts:2047</a></li>
|
|
152
153
|
</ul>
|
|
153
154
|
</aside>
|
|
154
155
|
<div class="tsd-comment tsd-typography">
|
|
@@ -159,11 +160,11 @@
|
|
|
159
160
|
</section>
|
|
160
161
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
161
162
|
<a name="metadata" class="tsd-anchor"></a>
|
|
162
|
-
<h3>metadata</h3>
|
|
163
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
163
164
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
164
165
|
<aside class="tsd-sources">
|
|
165
166
|
<ul>
|
|
166
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
167
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2055">datatypes.ts:2055</a></li>
|
|
167
168
|
</ul>
|
|
168
169
|
</aside>
|
|
169
170
|
<div class="tsd-comment tsd-typography">
|
|
@@ -172,13 +173,28 @@
|
|
|
172
173
|
</div>
|
|
173
174
|
</div>
|
|
174
175
|
</section>
|
|
176
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
177
|
+
<a name="ownerId" class="tsd-anchor"></a>
|
|
178
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> owner<wbr>Id</h3>
|
|
179
|
+
<div class="tsd-signature tsd-kind-icon">owner<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
180
|
+
<aside class="tsd-sources">
|
|
181
|
+
<ul>
|
|
182
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2061">datatypes.ts:2061</a></li>
|
|
183
|
+
</ul>
|
|
184
|
+
</aside>
|
|
185
|
+
<div class="tsd-comment tsd-typography">
|
|
186
|
+
<div class="lead">
|
|
187
|
+
<p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
|
|
188
|
+
</div>
|
|
189
|
+
</div>
|
|
190
|
+
</section>
|
|
175
191
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
176
192
|
<a name="publicKey" class="tsd-anchor"></a>
|
|
177
193
|
<h3>public<wbr>Key</h3>
|
|
178
194
|
<div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
179
195
|
<aside class="tsd-sources">
|
|
180
196
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
197
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2057">datatypes.ts:2057</a></li>
|
|
182
198
|
</ul>
|
|
183
199
|
</aside>
|
|
184
200
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,7 +209,7 @@
|
|
|
193
209
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
194
210
|
<aside class="tsd-sources">
|
|
195
211
|
<ul>
|
|
196
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
212
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2049">datatypes.ts:2049</a></li>
|
|
197
213
|
</ul>
|
|
198
214
|
</aside>
|
|
199
215
|
<div class="tsd-comment tsd-typography">
|
|
@@ -243,6 +259,9 @@
|
|
|
243
259
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
244
260
|
<a href="datatypes.SSHCredential.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
245
261
|
</li>
|
|
262
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
263
|
+
<a href="datatypes.SSHCredential.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a>
|
|
264
|
+
</li>
|
|
246
265
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
247
266
|
<a href="datatypes.SSHCredential.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
|
|
248
267
|
</li>
|