@ngrok/ngrok-api 0.2.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -28
- package/docs/CNAME +1 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +204 -119
- package/docs/classes/services.APIKeys.html +6 -105
- package/docs/classes/services.AbuseReports.html +3 -102
- package/docs/classes/{services.IPWhitelist.html → services.AgentIngresses.html} +41 -148
- package/docs/classes/services.CertificateAuthorities.html +6 -105
- package/docs/classes/services.Credentials.html +6 -105
- package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
- package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +270 -0
- package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
- package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
- package/docs/classes/{services.EndpointResponseHeadersModule.html → services.EdgeRouteRequestHeadersModule.html} +28 -127
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
- package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
- package/docs/classes/services.EdgesHTTPS.html +343 -0
- package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
- package/docs/classes/services.EdgesTCP.html +343 -0
- package/docs/classes/services.EdgesTLS.html +343 -0
- package/docs/classes/services.Endpoints.html +256 -0
- package/docs/classes/services.EventDestinations.html +7 -106
- package/docs/classes/services.EventSources.html +6 -105
- package/docs/classes/services.EventSubscriptions.html +6 -105
- package/docs/classes/{services.EventStreams.html → services.FailoverBackends.html} +51 -140
- package/docs/classes/services.HTTPResponseBackends.html +318 -0
- package/docs/classes/{services.EndpointMutualTLSModule.html → services.HTTPSEdgeMutualTLSModule.html} +22 -121
- package/docs/classes/{services.EndpointTLSTerminationModule.html → services.HTTPSEdgeTLSTerminationModule.html} +22 -121
- package/docs/classes/services.IPPolicies.html +6 -105
- package/docs/classes/services.IPPolicyRules.html +6 -105
- package/docs/classes/services.IPRestrictions.html +7 -106
- package/docs/classes/services.ReservedAddrs.html +6 -137
- package/docs/classes/services.ReservedDomains.html +8 -171
- package/docs/classes/services.SSHCertificateAuthorities.html +6 -105
- package/docs/classes/services.SSHCredentials.html +6 -105
- package/docs/classes/services.SSHHostCertificates.html +6 -105
- package/docs/classes/services.SSHUserCertificates.html +6 -105
- package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} +25 -124
- package/docs/classes/{services.EndpointIPPolicyModule.html → services.TCPEdgeIPRestrictionModule.html} +22 -121
- package/docs/classes/services.TLSCertificates.html +6 -105
- package/docs/classes/{services.EndpointLoggingModule.html → services.TLSEdgeBackendModule.html} +25 -124
- package/docs/classes/{services.EndpointOIDCModule.html → services.TLSEdgeIPRestrictionModule.html} +25 -124
- package/docs/classes/{services.EndpointOAuthModule.html → services.TLSEdgeMutualTLSModule.html} +25 -124
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
- package/docs/classes/services.TunnelGroupBackends.html +351 -0
- package/docs/classes/services.TunnelSessions.html +6 -105
- package/docs/classes/services.Tunnels.html +34 -101
- package/docs/classes/services.WeightedBackends.html +353 -0
- package/docs/index.html +0 -27
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +6 -6
- package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
- package/docs/interfaces/datatypes.APIKeyList.html +3 -3
- package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
- package/docs/interfaces/datatypes.AWSAuth.html +2 -2
- package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
- package/docs/interfaces/datatypes.AWSRole.html +1 -1
- package/docs/interfaces/datatypes.AbuseReport.html +7 -7
- package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/{datatypes.EventStream.html → datatypes.AgentIngress.html} +52 -71
- package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
- package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
- package/docs/interfaces/{datatypes.IPWhitelistEntryUpdate.html → datatypes.AgentIngressUpdate.html} +16 -16
- package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +7 -7
- package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/{datatypes.EndpointCircuitBreakerReplace.html → datatypes.EdgeBackendReplace.html} +12 -12
- package/docs/interfaces/{datatypes.EndpointIPPolicyReplace.html → datatypes.EdgeIPRestrictionReplace.html} +11 -11
- package/docs/interfaces/{datatypes.EndpointMutualTLSReplace.html → datatypes.EdgeMutualTLSReplace.html} +11 -11
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointCompressionReplace.html → datatypes.EdgeRouteCompressionReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
- package/docs/interfaces/{datatypes.ReservedDomainCertNSTarget.html → datatypes.EdgeRouteItem.html} +19 -19
- package/docs/interfaces/{datatypes.EndpointOAuthReplace.html → datatypes.EdgeRouteOAuthReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointRequestHeadersReplace.html → datatypes.EdgeRouteRequestHeadersReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointSAMLReplace.html → datatypes.EdgeRouteSAMLReplace.html} +25 -11
- package/docs/interfaces/{datatypes.EndpointWebhookValidationReplace.html → datatypes.EdgeRouteWebhookVerificationReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointResponseHeadersReplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +12 -12
- package/docs/interfaces/{datatypes.EndpointTLSTerminationReplace.html → datatypes.EdgeTLSTerminationReplace.html} +11 -11
- package/docs/interfaces/datatypes.Endpoint.html +395 -0
- package/docs/interfaces/{datatypes.EndpointLogging.html → datatypes.EndpointBackend.html} +19 -19
- package/docs/interfaces/{datatypes.EndpointLoggingMutate.html → datatypes.EndpointBackendMutate.html} +19 -19
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/{datatypes.EndpointConfigurationList.html → datatypes.EndpointList.html} +19 -19
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointSAML.html +33 -14
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +28 -9
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +186 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/{datatypes.EndpointOIDCReplace.html → datatypes.EndpointWebsocketTCPConverter.html} +16 -25
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +7 -7
- package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
- package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventSource.html +2 -2
- package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
- package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
- package/docs/interfaces/datatypes.EventSourceList.html +2 -2
- package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
- package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
- package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
- package/docs/interfaces/datatypes.EventSubscription.html +7 -7
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +5 -5
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +6 -6
- package/docs/interfaces/datatypes.EventTarget.html +3 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/{datatypes.IPWhitelistEntry.html → datatypes.FailoverBackend.html} +41 -41
- package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.FailoverBackendCreate.html} +23 -23
- package/docs/interfaces/datatypes.FailoverBackendList.html +205 -0
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +219 -0
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +243 -0
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +190 -0
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +257 -0
- package/docs/interfaces/datatypes.HTTPSEdge.html +314 -0
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
- package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRoute.html} +154 -78
- package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
- package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +104 -123
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +257 -0
- package/docs/interfaces/datatypes.IPPolicy.html +5 -24
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -21
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +26 -7
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +23 -4
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +8 -8
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -26
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -22
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -22
- package/docs/interfaces/datatypes.ReservedDomain.html +30 -49
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -23
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -44
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -43
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +7 -7
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TCPEdge.html +295 -0
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +238 -0
- package/docs/interfaces/{datatypes.IPWhitelistEntryList.html → datatypes.TCPEdgeList.html} +22 -22
- package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.TCPEdgeUpdate.html} +43 -48
- package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
- package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TLSEdge.html +323 -0
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
- package/docs/interfaces/{datatypes.EventStreamList.html → datatypes.TLSEdgeList.html} +23 -23
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +285 -0
- package/docs/interfaces/datatypes.Tunnel.html +85 -9
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +205 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +205 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +219 -0
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +10 -10
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/{datatypes.EventStreamCreate.html → datatypes.WeightedBackend.html} +44 -44
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
- package/docs/interfaces/datatypes.WeightedBackendList.html +205 -0
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
- package/docs/modules/datatypes.html +213 -89
- package/docs/modules/services.html +89 -33
- package/lib/client.d.ts +54 -24
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +45 -22
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +617 -281
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +385 -169
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +1432 -597
- package/lib/services.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +98 -45
- package/src/datatypes.ts +669 -302
- package/src/services.ts +1426 -610
- package/docs/classes/services.EndpointCircuitBreakerModule.html +0 -369
- package/docs/classes/services.EndpointCompressionModule.html +0 -369
- package/docs/classes/services.EndpointConfigurations.html +0 -451
- package/docs/classes/services.EndpointRequestHeadersModule.html +0 -369
- package/docs/classes/services.EndpointWebhookValidationModule.html +0 -369
- package/docs/interfaces/datatypes.EndpointLoggingReplace.html +0 -176
- package/test/endpointConfigurations.test.js +0 -67
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
-
<title>
|
|
6
|
+
<title>AgentIngresses | @ngrok/ngrok-api</title>
|
|
7
7
|
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
8
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
9
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
@@ -58,29 +58,21 @@
|
|
|
58
58
|
<a href="../modules/services.html">services</a>
|
|
59
59
|
</li>
|
|
60
60
|
<li>
|
|
61
|
-
<a href="services.
|
|
61
|
+
<a href="services.AgentIngresses.html">AgentIngresses</a>
|
|
62
62
|
</li>
|
|
63
63
|
</ul>
|
|
64
|
-
<h1>Class
|
|
64
|
+
<h1>Class AgentIngresses</h1>
|
|
65
65
|
</div>
|
|
66
66
|
</div>
|
|
67
67
|
</header>
|
|
68
68
|
<div class="container container-main">
|
|
69
69
|
<div class="row">
|
|
70
70
|
<div class="col-8 col-content">
|
|
71
|
-
<section class="tsd-panel tsd-comment">
|
|
72
|
-
<div class="tsd-comment tsd-typography">
|
|
73
|
-
<div class="lead">
|
|
74
|
-
<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction
|
|
75
|
-
with an <code>endpoints</code> type instead.</p>
|
|
76
|
-
</div>
|
|
77
|
-
</div>
|
|
78
|
-
</section>
|
|
79
71
|
<section class="tsd-panel tsd-hierarchy">
|
|
80
72
|
<h3>Hierarchy</h3>
|
|
81
73
|
<ul class="tsd-hierarchy">
|
|
82
74
|
<li>
|
|
83
|
-
<span class="target">
|
|
75
|
+
<span class="target">AgentIngresses</span>
|
|
84
76
|
</li>
|
|
85
77
|
</ul>
|
|
86
78
|
</section>
|
|
@@ -91,17 +83,17 @@
|
|
|
91
83
|
<section class="tsd-index-section ">
|
|
92
84
|
<h3>Constructors</h3>
|
|
93
85
|
<ul class="tsd-index-list">
|
|
94
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.
|
|
86
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.AgentIngresses.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
95
87
|
</ul>
|
|
96
88
|
</section>
|
|
97
89
|
<section class="tsd-index-section ">
|
|
98
90
|
<h3>Methods</h3>
|
|
99
91
|
<ul class="tsd-index-list">
|
|
100
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.
|
|
101
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.
|
|
102
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.
|
|
103
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.
|
|
104
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.
|
|
92
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.AgentIngresses.html#create" class="tsd-kind-icon">create</a></li>
|
|
93
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.AgentIngresses.html#delete" class="tsd-kind-icon">delete</a></li>
|
|
94
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.AgentIngresses.html#get" class="tsd-kind-icon">get</a></li>
|
|
95
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.AgentIngresses.html#list" class="tsd-kind-icon">list</a></li>
|
|
96
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.AgentIngresses.html#update" class="tsd-kind-icon">update</a></li>
|
|
105
97
|
</ul>
|
|
106
98
|
</section>
|
|
107
99
|
</div>
|
|
@@ -113,18 +105,18 @@
|
|
|
113
105
|
<a name="constructor" class="tsd-anchor"></a>
|
|
114
106
|
<h3>constructor</h3>
|
|
115
107
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
116
|
-
<li class="tsd-signature tsd-kind-icon">new
|
|
108
|
+
<li class="tsd-signature tsd-kind-icon">new <wbr>Agent<wbr>Ingresses<span class="tsd-signature-symbol">(</span>httpClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Wretcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="services.AgentIngresses.html" class="tsd-signature-type" data-tsd-kind="Class">AgentIngresses</a></li>
|
|
117
109
|
</ul>
|
|
118
110
|
<ul class="tsd-descriptions">
|
|
119
111
|
<li class="tsd-description">
|
|
120
112
|
<aside class="tsd-sources">
|
|
121
113
|
<ul>
|
|
122
|
-
<li>Defined in services.ts:
|
|
114
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L46">services.ts:46</a></li>
|
|
123
115
|
</ul>
|
|
124
116
|
</aside>
|
|
125
117
|
<div class="tsd-comment tsd-typography">
|
|
126
118
|
<div class="lead">
|
|
127
|
-
<p>Do not construct this object directly, use the <code>
|
|
119
|
+
<p>Do not construct this object directly, use the <code>agentIngresses</code> property of an <code>Ngrok</code> client object instead.</p>
|
|
128
120
|
</div>
|
|
129
121
|
</div>
|
|
130
122
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -133,7 +125,7 @@
|
|
|
133
125
|
<h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
|
|
134
126
|
</li>
|
|
135
127
|
</ul>
|
|
136
|
-
<h4 class="tsd-returns-title">Returns <a href="services.
|
|
128
|
+
<h4 class="tsd-returns-title">Returns <a href="services.AgentIngresses.html" class="tsd-signature-type" data-tsd-kind="Class">AgentIngresses</a></h4>
|
|
137
129
|
</li>
|
|
138
130
|
</ul>
|
|
139
131
|
</section>
|
|
@@ -144,27 +136,27 @@
|
|
|
144
136
|
<a name="create" class="tsd-anchor"></a>
|
|
145
137
|
<h3>create</h3>
|
|
146
138
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
147
|
-
<li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.
|
|
139
|
+
<li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.AgentIngressCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngressCreate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">></span></li>
|
|
148
140
|
</ul>
|
|
149
141
|
<ul class="tsd-descriptions">
|
|
150
142
|
<li class="tsd-description">
|
|
151
143
|
<aside class="tsd-sources">
|
|
152
144
|
<ul>
|
|
153
|
-
<li>Defined in services.ts:
|
|
145
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L52">services.ts:52</a></li>
|
|
154
146
|
</ul>
|
|
155
147
|
</aside>
|
|
156
148
|
<div class="tsd-comment tsd-typography">
|
|
157
149
|
<div class="lead">
|
|
158
|
-
<p>Create a new
|
|
150
|
+
<p>Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.</p>
|
|
159
151
|
</div>
|
|
160
152
|
</div>
|
|
161
153
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
162
154
|
<ul class="tsd-parameters">
|
|
163
155
|
<li>
|
|
164
|
-
<h5>arg: <a href="../interfaces/datatypes.
|
|
156
|
+
<h5>arg: <a href="../interfaces/datatypes.AgentIngressCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngressCreate</a></h5>
|
|
165
157
|
</li>
|
|
166
158
|
</ul>
|
|
167
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.
|
|
159
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">></span></h4>
|
|
168
160
|
</li>
|
|
169
161
|
</ul>
|
|
170
162
|
</section>
|
|
@@ -178,12 +170,12 @@
|
|
|
178
170
|
<li class="tsd-description">
|
|
179
171
|
<aside class="tsd-sources">
|
|
180
172
|
<ul>
|
|
181
|
-
<li>Defined in services.ts:
|
|
173
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L65">services.ts:65</a></li>
|
|
182
174
|
</ul>
|
|
183
175
|
</aside>
|
|
184
176
|
<div class="tsd-comment tsd-typography">
|
|
185
177
|
<div class="lead">
|
|
186
|
-
<p>Delete an
|
|
178
|
+
<p>Delete an Agent Ingress by ID</p>
|
|
187
179
|
</div>
|
|
188
180
|
</div>
|
|
189
181
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -200,18 +192,18 @@
|
|
|
200
192
|
<a name="get" class="tsd-anchor"></a>
|
|
201
193
|
<h3>get</h3>
|
|
202
194
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
203
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.
|
|
195
|
+
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">></span></li>
|
|
204
196
|
</ul>
|
|
205
197
|
<ul class="tsd-descriptions">
|
|
206
198
|
<li class="tsd-description">
|
|
207
199
|
<aside class="tsd-sources">
|
|
208
200
|
<ul>
|
|
209
|
-
<li>Defined in services.ts:
|
|
201
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L76">services.ts:76</a></li>
|
|
210
202
|
</ul>
|
|
211
203
|
</aside>
|
|
212
204
|
<div class="tsd-comment tsd-typography">
|
|
213
205
|
<div class="lead">
|
|
214
|
-
<p>Get
|
|
206
|
+
<p>Get the details of an Agent Ingress by ID.</p>
|
|
215
207
|
</div>
|
|
216
208
|
</div>
|
|
217
209
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -220,7 +212,7 @@
|
|
|
220
212
|
<h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
|
|
221
213
|
</li>
|
|
222
214
|
</ul>
|
|
223
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.
|
|
215
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">></span></h4>
|
|
224
216
|
</li>
|
|
225
217
|
</ul>
|
|
226
218
|
</section>
|
|
@@ -228,21 +220,21 @@
|
|
|
228
220
|
<a name="list" class="tsd-anchor"></a>
|
|
229
221
|
<h3>list</h3>
|
|
230
222
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
231
|
-
<li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.
|
|
223
|
+
<li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
232
224
|
</ul>
|
|
233
225
|
<ul class="tsd-descriptions">
|
|
234
226
|
<li class="tsd-description">
|
|
235
227
|
<aside class="tsd-sources">
|
|
236
228
|
<ul>
|
|
237
|
-
<li>Defined in services.ts:
|
|
229
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L87">services.ts:87</a></li>
|
|
238
230
|
</ul>
|
|
239
231
|
</aside>
|
|
240
232
|
<div class="tsd-comment tsd-typography">
|
|
241
233
|
<div class="lead">
|
|
242
|
-
<p>List all
|
|
234
|
+
<p>List all Agent Ingresses owned by this account</p>
|
|
243
235
|
</div>
|
|
244
236
|
</div>
|
|
245
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.
|
|
237
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
246
238
|
</li>
|
|
247
239
|
</ul>
|
|
248
240
|
</section>
|
|
@@ -250,27 +242,27 @@
|
|
|
250
242
|
<a name="update" class="tsd-anchor"></a>
|
|
251
243
|
<h3>update</h3>
|
|
252
244
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
253
|
-
<li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.
|
|
245
|
+
<li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.AgentIngressUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngressUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">></span></li>
|
|
254
246
|
</ul>
|
|
255
247
|
<ul class="tsd-descriptions">
|
|
256
248
|
<li class="tsd-description">
|
|
257
249
|
<aside class="tsd-sources">
|
|
258
250
|
<ul>
|
|
259
|
-
<li>Defined in services.ts:
|
|
251
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L129">services.ts:129</a></li>
|
|
260
252
|
</ul>
|
|
261
253
|
</aside>
|
|
262
254
|
<div class="tsd-comment tsd-typography">
|
|
263
255
|
<div class="lead">
|
|
264
|
-
<p>Update attributes of an
|
|
256
|
+
<p>Update attributes of an Agent Ingress by ID.</p>
|
|
265
257
|
</div>
|
|
266
258
|
</div>
|
|
267
259
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
268
260
|
<ul class="tsd-parameters">
|
|
269
261
|
<li>
|
|
270
|
-
<h5>arg: <a href="../interfaces/datatypes.
|
|
262
|
+
<h5>arg: <a href="../interfaces/datatypes.AgentIngressUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngressUpdate</a></h5>
|
|
271
263
|
</li>
|
|
272
264
|
</ul>
|
|
273
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.
|
|
265
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">></span></h4>
|
|
274
266
|
</li>
|
|
275
267
|
</ul>
|
|
276
268
|
</section>
|
|
@@ -295,132 +287,33 @@
|
|
|
295
287
|
</nav>
|
|
296
288
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
297
289
|
<ul class="before-current">
|
|
298
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
299
|
-
<a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
|
|
300
|
-
</li>
|
|
301
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
302
|
-
<a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
|
|
303
|
-
</li>
|
|
304
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
305
|
-
<a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
|
|
306
|
-
</li>
|
|
307
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
308
|
-
<a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
|
|
309
|
-
</li>
|
|
310
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
311
|
-
<a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
|
|
312
|
-
</li>
|
|
313
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
314
|
-
<a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
|
|
315
|
-
</li>
|
|
316
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
317
|
-
<a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
|
|
318
|
-
</li>
|
|
319
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
320
|
-
<a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
|
|
321
|
-
</li>
|
|
322
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
323
|
-
<a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
|
|
324
|
-
</li>
|
|
325
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
326
|
-
<a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
|
|
327
|
-
</li>
|
|
328
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
329
|
-
<a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
|
|
330
|
-
</li>
|
|
331
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
332
|
-
<a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
|
|
333
|
-
</li>
|
|
334
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
335
|
-
<a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
|
|
336
|
-
</li>
|
|
337
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
338
|
-
<a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
|
|
339
|
-
</li>
|
|
340
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
341
|
-
<a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
|
|
342
|
-
</li>
|
|
343
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
344
|
-
<a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
|
|
345
|
-
</li>
|
|
346
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
347
|
-
<a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
|
|
348
|
-
</li>
|
|
349
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
350
|
-
<a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
|
|
351
|
-
</li>
|
|
352
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
353
|
-
<a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
|
|
354
|
-
</li>
|
|
355
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
356
|
-
<a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
|
|
357
|
-
</li>
|
|
358
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
359
|
-
<a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
|
|
360
|
-
</li>
|
|
361
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
362
|
-
<a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
|
|
363
|
-
</li>
|
|
364
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
365
|
-
<a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
|
|
366
|
-
</li>
|
|
367
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
368
|
-
<a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
|
|
369
|
-
</li>
|
|
370
290
|
</ul>
|
|
371
291
|
<ul class="current">
|
|
372
292
|
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
373
|
-
<a href="services.
|
|
293
|
+
<a href="services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
|
|
374
294
|
<ul>
|
|
375
295
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
376
|
-
<a href="services.
|
|
296
|
+
<a href="services.AgentIngresses.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
377
297
|
</li>
|
|
378
298
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
379
|
-
<a href="services.
|
|
299
|
+
<a href="services.AgentIngresses.html#create" class="tsd-kind-icon">create</a>
|
|
380
300
|
</li>
|
|
381
301
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
382
|
-
<a href="services.
|
|
302
|
+
<a href="services.AgentIngresses.html#delete" class="tsd-kind-icon">delete</a>
|
|
383
303
|
</li>
|
|
384
304
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
385
|
-
<a href="services.
|
|
305
|
+
<a href="services.AgentIngresses.html#get" class="tsd-kind-icon">get</a>
|
|
386
306
|
</li>
|
|
387
307
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
388
|
-
<a href="services.
|
|
308
|
+
<a href="services.AgentIngresses.html#list" class="tsd-kind-icon">list</a>
|
|
389
309
|
</li>
|
|
390
310
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
391
|
-
<a href="services.
|
|
311
|
+
<a href="services.AgentIngresses.html#update" class="tsd-kind-icon">update</a>
|
|
392
312
|
</li>
|
|
393
313
|
</ul>
|
|
394
314
|
</li>
|
|
395
315
|
</ul>
|
|
396
316
|
<ul class="after-current">
|
|
397
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
398
|
-
<a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
|
|
399
|
-
</li>
|
|
400
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
401
|
-
<a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
|
|
402
|
-
</li>
|
|
403
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
404
|
-
<a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
|
|
405
|
-
</li>
|
|
406
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
407
|
-
<a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
|
|
408
|
-
</li>
|
|
409
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
410
|
-
<a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
|
|
411
|
-
</li>
|
|
412
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
413
|
-
<a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
|
|
414
|
-
</li>
|
|
415
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
416
|
-
<a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
|
|
417
|
-
</li>
|
|
418
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
419
|
-
<a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
|
|
420
|
-
</li>
|
|
421
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
422
|
-
<a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
|
|
423
|
-
</li>
|
|
424
317
|
</ul>
|
|
425
318
|
</nav>
|
|
426
319
|
</div>
|
|
@@ -122,7 +122,7 @@
|
|
|
122
122
|
<li class="tsd-description">
|
|
123
123
|
<aside class="tsd-sources">
|
|
124
124
|
<ul>
|
|
125
|
-
<li>Defined in services.ts:
|
|
125
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L643">services.ts:643</a></li>
|
|
126
126
|
</ul>
|
|
127
127
|
</aside>
|
|
128
128
|
<div class="tsd-comment tsd-typography">
|
|
@@ -153,7 +153,7 @@
|
|
|
153
153
|
<li class="tsd-description">
|
|
154
154
|
<aside class="tsd-sources">
|
|
155
155
|
<ul>
|
|
156
|
-
<li>Defined in services.ts:
|
|
156
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L649">services.ts:649</a></li>
|
|
157
157
|
</ul>
|
|
158
158
|
</aside>
|
|
159
159
|
<div class="tsd-comment tsd-typography">
|
|
@@ -181,7 +181,7 @@
|
|
|
181
181
|
<li class="tsd-description">
|
|
182
182
|
<aside class="tsd-sources">
|
|
183
183
|
<ul>
|
|
184
|
-
<li>Defined in services.ts:
|
|
184
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L662">services.ts:662</a></li>
|
|
185
185
|
</ul>
|
|
186
186
|
</aside>
|
|
187
187
|
<div class="tsd-comment tsd-typography">
|
|
@@ -209,7 +209,7 @@
|
|
|
209
209
|
<li class="tsd-description">
|
|
210
210
|
<aside class="tsd-sources">
|
|
211
211
|
<ul>
|
|
212
|
-
<li>Defined in services.ts:
|
|
212
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L673">services.ts:673</a></li>
|
|
213
213
|
</ul>
|
|
214
214
|
</aside>
|
|
215
215
|
<div class="tsd-comment tsd-typography">
|
|
@@ -237,7 +237,7 @@
|
|
|
237
237
|
<li class="tsd-description">
|
|
238
238
|
<aside class="tsd-sources">
|
|
239
239
|
<ul>
|
|
240
|
-
<li>Defined in services.ts:
|
|
240
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L684">services.ts:684</a></li>
|
|
241
241
|
</ul>
|
|
242
242
|
</aside>
|
|
243
243
|
<div class="tsd-comment tsd-typography">
|
|
@@ -259,7 +259,7 @@
|
|
|
259
259
|
<li class="tsd-description">
|
|
260
260
|
<aside class="tsd-sources">
|
|
261
261
|
<ul>
|
|
262
|
-
<li>Defined in services.ts:
|
|
262
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L727">services.ts:727</a></li>
|
|
263
263
|
</ul>
|
|
264
264
|
</aside>
|
|
265
265
|
<div class="tsd-comment tsd-typography">
|
|
@@ -298,12 +298,6 @@
|
|
|
298
298
|
</nav>
|
|
299
299
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
300
300
|
<ul class="before-current">
|
|
301
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
302
|
-
<a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
|
|
303
|
-
</li>
|
|
304
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
305
|
-
<a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
|
|
306
|
-
</li>
|
|
307
301
|
</ul>
|
|
308
302
|
<ul class="current">
|
|
309
303
|
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
@@ -331,99 +325,6 @@
|
|
|
331
325
|
</li>
|
|
332
326
|
</ul>
|
|
333
327
|
<ul class="after-current">
|
|
334
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
335
|
-
<a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
|
|
336
|
-
</li>
|
|
337
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
338
|
-
<a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
|
|
339
|
-
</li>
|
|
340
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
341
|
-
<a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
|
|
342
|
-
</li>
|
|
343
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
344
|
-
<a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
|
|
345
|
-
</li>
|
|
346
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
347
|
-
<a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
|
|
348
|
-
</li>
|
|
349
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
350
|
-
<a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
|
|
351
|
-
</li>
|
|
352
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
353
|
-
<a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
|
|
354
|
-
</li>
|
|
355
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
356
|
-
<a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
|
|
357
|
-
</li>
|
|
358
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
359
|
-
<a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
|
|
360
|
-
</li>
|
|
361
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
362
|
-
<a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
|
|
363
|
-
</li>
|
|
364
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
365
|
-
<a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
|
|
366
|
-
</li>
|
|
367
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
368
|
-
<a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
|
|
369
|
-
</li>
|
|
370
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
371
|
-
<a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
|
|
372
|
-
</li>
|
|
373
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
374
|
-
<a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
|
|
375
|
-
</li>
|
|
376
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
377
|
-
<a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
|
|
378
|
-
</li>
|
|
379
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
380
|
-
<a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
|
|
381
|
-
</li>
|
|
382
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
383
|
-
<a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
|
|
384
|
-
</li>
|
|
385
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
386
|
-
<a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
|
|
387
|
-
</li>
|
|
388
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
389
|
-
<a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
|
|
390
|
-
</li>
|
|
391
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
392
|
-
<a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
|
|
393
|
-
</li>
|
|
394
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
395
|
-
<a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
|
|
396
|
-
</li>
|
|
397
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
398
|
-
<a href="services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a>
|
|
399
|
-
</li>
|
|
400
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
401
|
-
<a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
|
|
402
|
-
</li>
|
|
403
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
404
|
-
<a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
|
|
405
|
-
</li>
|
|
406
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
407
|
-
<a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
|
|
408
|
-
</li>
|
|
409
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
410
|
-
<a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
|
|
411
|
-
</li>
|
|
412
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
413
|
-
<a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
|
|
414
|
-
</li>
|
|
415
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
416
|
-
<a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
|
|
417
|
-
</li>
|
|
418
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
419
|
-
<a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
|
|
420
|
-
</li>
|
|
421
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
422
|
-
<a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
|
|
423
|
-
</li>
|
|
424
|
-
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
425
|
-
<a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
|
|
426
|
-
</li>
|
|
427
328
|
</ul>
|
|
428
329
|
</nav>
|
|
429
330
|
</div>
|