@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
|
@@ -0,0 +1,395 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>Endpoint | @ngrok/ngrok-api</title>
|
|
7
|
+
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header>
|
|
14
|
+
<div class="tsd-page-toolbar">
|
|
15
|
+
<div class="container">
|
|
16
|
+
<div class="table-wrap">
|
|
17
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
18
|
+
<div class="field">
|
|
19
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
20
|
+
<input id="tsd-search-field" type="text" />
|
|
21
|
+
</div>
|
|
22
|
+
<ul class="results">
|
|
23
|
+
<li class="state loading">Preparing search index...</li>
|
|
24
|
+
<li class="state failure">The search index is not available</li>
|
|
25
|
+
</ul>
|
|
26
|
+
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
|
|
27
|
+
</div>
|
|
28
|
+
<div class="table-cell" id="tsd-widgets">
|
|
29
|
+
<div id="tsd-filter">
|
|
30
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
31
|
+
<div class="tsd-filter-group">
|
|
32
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
33
|
+
<span class="tsd-select-label">All</span>
|
|
34
|
+
<ul class="tsd-select-list">
|
|
35
|
+
<li data-value="public">Public</li>
|
|
36
|
+
<li data-value="protected">Public/Protected</li>
|
|
37
|
+
<li data-value="private" class="selected">All</li>
|
|
38
|
+
</ul>
|
|
39
|
+
</div>
|
|
40
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
41
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
42
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
43
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
47
|
+
</div>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="tsd-page-title">
|
|
52
|
+
<div class="container">
|
|
53
|
+
<ul class="tsd-breadcrumb">
|
|
54
|
+
<li>
|
|
55
|
+
<a href="../modules.html">@ngrok/ngrok-api</a>
|
|
56
|
+
</li>
|
|
57
|
+
<li>
|
|
58
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="datatypes.Endpoint.html">Endpoint</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface Endpoint</h1>
|
|
65
|
+
</div>
|
|
66
|
+
</div>
|
|
67
|
+
</header>
|
|
68
|
+
<div class="container container-main">
|
|
69
|
+
<div class="row">
|
|
70
|
+
<div class="col-8 col-content">
|
|
71
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
72
|
+
<h3>Hierarchy</h3>
|
|
73
|
+
<ul class="tsd-hierarchy">
|
|
74
|
+
<li>
|
|
75
|
+
<span class="target">Endpoint</span>
|
|
76
|
+
</li>
|
|
77
|
+
</ul>
|
|
78
|
+
</section>
|
|
79
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
80
|
+
<h2>Index</h2>
|
|
81
|
+
<section class="tsd-panel tsd-index-panel">
|
|
82
|
+
<div class="tsd-index-content">
|
|
83
|
+
<section class="tsd-index-section ">
|
|
84
|
+
<h3>Properties</h3>
|
|
85
|
+
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#domain" class="tsd-kind-icon">domain</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#edge" class="tsd-kind-icon">edge</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#hostport" class="tsd-kind-icon">hostport</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#id" class="tsd-kind-icon">id</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
92
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#proto" class="tsd-kind-icon">proto</a></li>
|
|
93
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a></li>
|
|
94
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#region" class="tsd-kind-icon">region</a></li>
|
|
95
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#tcpAddr" class="tsd-kind-icon">tcp<wbr>Addr</a></li>
|
|
96
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#tunnel" class="tsd-kind-icon">tunnel</a></li>
|
|
97
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#type" class="tsd-kind-icon">type</a></li>
|
|
98
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a></li>
|
|
99
|
+
</ul>
|
|
100
|
+
</section>
|
|
101
|
+
</div>
|
|
102
|
+
</section>
|
|
103
|
+
</section>
|
|
104
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
105
|
+
<h2>Properties</h2>
|
|
106
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
107
|
+
<a name="createdAt" class="tsd-anchor"></a>
|
|
108
|
+
<h3>created<wbr>At</h3>
|
|
109
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
110
|
+
<aside class="tsd-sources">
|
|
111
|
+
<ul>
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1074">datatypes.ts:1074</a></li>
|
|
113
|
+
</ul>
|
|
114
|
+
</aside>
|
|
115
|
+
<div class="tsd-comment tsd-typography">
|
|
116
|
+
<div class="lead">
|
|
117
|
+
<p>timestamp when the endpoint was created in RFC 3339 format</p>
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
</section>
|
|
121
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
122
|
+
<a name="domain" class="tsd-anchor"></a>
|
|
123
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> domain</h3>
|
|
124
|
+
<div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
125
|
+
<aside class="tsd-sources">
|
|
126
|
+
<ul>
|
|
127
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1088">datatypes.ts:1088</a></li>
|
|
128
|
+
</ul>
|
|
129
|
+
</aside>
|
|
130
|
+
<div class="tsd-comment tsd-typography">
|
|
131
|
+
<div class="lead">
|
|
132
|
+
<p>the domain reserved for this endpoint</p>
|
|
133
|
+
</div>
|
|
134
|
+
</div>
|
|
135
|
+
</section>
|
|
136
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
137
|
+
<a name="edge" class="tsd-anchor"></a>
|
|
138
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> edge</h3>
|
|
139
|
+
<div class="tsd-signature tsd-kind-icon">edge<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
140
|
+
<aside class="tsd-sources">
|
|
141
|
+
<ul>
|
|
142
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1094">datatypes.ts:1094</a></li>
|
|
143
|
+
</ul>
|
|
144
|
+
</aside>
|
|
145
|
+
<div class="tsd-comment tsd-typography">
|
|
146
|
+
<div class="lead">
|
|
147
|
+
<p>the edge serving requests to this endpoint, if this is an edge endpoint</p>
|
|
148
|
+
</div>
|
|
149
|
+
</div>
|
|
150
|
+
</section>
|
|
151
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
152
|
+
<a name="hostport" class="tsd-anchor"></a>
|
|
153
|
+
<h3>hostport</h3>
|
|
154
|
+
<div class="tsd-signature tsd-kind-icon">hostport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
155
|
+
<aside class="tsd-sources">
|
|
156
|
+
<ul>
|
|
157
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1082">datatypes.ts:1082</a></li>
|
|
158
|
+
</ul>
|
|
159
|
+
</aside>
|
|
160
|
+
<div class="tsd-comment tsd-typography">
|
|
161
|
+
<div class="lead">
|
|
162
|
+
<p>hostport served by this endpoint (hostname:port)</p>
|
|
163
|
+
</div>
|
|
164
|
+
</div>
|
|
165
|
+
</section>
|
|
166
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
167
|
+
<a name="id" class="tsd-anchor"></a>
|
|
168
|
+
<h3>id</h3>
|
|
169
|
+
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
170
|
+
<aside class="tsd-sources">
|
|
171
|
+
<ul>
|
|
172
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1070">datatypes.ts:1070</a></li>
|
|
173
|
+
</ul>
|
|
174
|
+
</aside>
|
|
175
|
+
<div class="tsd-comment tsd-typography">
|
|
176
|
+
<div class="lead">
|
|
177
|
+
<p>unique endpoint resource identifier</p>
|
|
178
|
+
</div>
|
|
179
|
+
</div>
|
|
180
|
+
</section>
|
|
181
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
182
|
+
<a name="metadata" class="tsd-anchor"></a>
|
|
183
|
+
<h3>metadata</h3>
|
|
184
|
+
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
185
|
+
<aside class="tsd-sources">
|
|
186
|
+
<ul>
|
|
187
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1086">datatypes.ts:1086</a></li>
|
|
188
|
+
</ul>
|
|
189
|
+
</aside>
|
|
190
|
+
<div class="tsd-comment tsd-typography">
|
|
191
|
+
<div class="lead">
|
|
192
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
|
193
|
+
</div>
|
|
194
|
+
</div>
|
|
195
|
+
</section>
|
|
196
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
197
|
+
<a name="proto" class="tsd-anchor"></a>
|
|
198
|
+
<h3>proto</h3>
|
|
199
|
+
<div class="tsd-signature tsd-kind-icon">proto<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
200
|
+
<aside class="tsd-sources">
|
|
201
|
+
<ul>
|
|
202
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1080">datatypes.ts:1080</a></li>
|
|
203
|
+
</ul>
|
|
204
|
+
</aside>
|
|
205
|
+
<div class="tsd-comment tsd-typography">
|
|
206
|
+
<div class="lead">
|
|
207
|
+
<p>protocol served by this endpoint. one of <code>http</code>, <code>https</code>, <code>tcp</code>, or <code>tls</code></p>
|
|
208
|
+
</div>
|
|
209
|
+
</div>
|
|
210
|
+
</section>
|
|
211
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
212
|
+
<a name="publicUrl" class="tsd-anchor"></a>
|
|
213
|
+
<h3>public<wbr>Url</h3>
|
|
214
|
+
<div class="tsd-signature tsd-kind-icon">public<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
215
|
+
<aside class="tsd-sources">
|
|
216
|
+
<ul>
|
|
217
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1078">datatypes.ts:1078</a></li>
|
|
218
|
+
</ul>
|
|
219
|
+
</aside>
|
|
220
|
+
<div class="tsd-comment tsd-typography">
|
|
221
|
+
<div class="lead">
|
|
222
|
+
<p>URL of the hostport served by this endpoint</p>
|
|
223
|
+
</div>
|
|
224
|
+
</div>
|
|
225
|
+
</section>
|
|
226
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
227
|
+
<a name="region" class="tsd-anchor"></a>
|
|
228
|
+
<h3>region</h3>
|
|
229
|
+
<div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
230
|
+
<aside class="tsd-sources">
|
|
231
|
+
<ul>
|
|
232
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1072">datatypes.ts:1072</a></li>
|
|
233
|
+
</ul>
|
|
234
|
+
</aside>
|
|
235
|
+
<div class="tsd-comment tsd-typography">
|
|
236
|
+
<div class="lead">
|
|
237
|
+
<p>identifier of the region this endpoint belongs to</p>
|
|
238
|
+
</div>
|
|
239
|
+
</div>
|
|
240
|
+
</section>
|
|
241
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
242
|
+
<a name="tcpAddr" class="tsd-anchor"></a>
|
|
243
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tcp<wbr>Addr</h3>
|
|
244
|
+
<div class="tsd-signature tsd-kind-icon">tcp<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
245
|
+
<aside class="tsd-sources">
|
|
246
|
+
<ul>
|
|
247
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1090">datatypes.ts:1090</a></li>
|
|
248
|
+
</ul>
|
|
249
|
+
</aside>
|
|
250
|
+
<div class="tsd-comment tsd-typography">
|
|
251
|
+
<div class="lead">
|
|
252
|
+
<p>the address reserved for this endpoint</p>
|
|
253
|
+
</div>
|
|
254
|
+
</div>
|
|
255
|
+
</section>
|
|
256
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
257
|
+
<a name="tunnel" class="tsd-anchor"></a>
|
|
258
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tunnel</h3>
|
|
259
|
+
<div class="tsd-signature tsd-kind-icon">tunnel<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
260
|
+
<aside class="tsd-sources">
|
|
261
|
+
<ul>
|
|
262
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1092">datatypes.ts:1092</a></li>
|
|
263
|
+
</ul>
|
|
264
|
+
</aside>
|
|
265
|
+
<div class="tsd-comment tsd-typography">
|
|
266
|
+
<div class="lead">
|
|
267
|
+
<p>the tunnel serving requests to this endpoint, if this is an ephemeral endpoint</p>
|
|
268
|
+
</div>
|
|
269
|
+
</div>
|
|
270
|
+
</section>
|
|
271
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
272
|
+
<a name="type" class="tsd-anchor"></a>
|
|
273
|
+
<h3>type</h3>
|
|
274
|
+
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
275
|
+
<aside class="tsd-sources">
|
|
276
|
+
<ul>
|
|
277
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1084">datatypes.ts:1084</a></li>
|
|
278
|
+
</ul>
|
|
279
|
+
</aside>
|
|
280
|
+
<div class="tsd-comment tsd-typography">
|
|
281
|
+
<div class="lead">
|
|
282
|
+
<p>whether the endpoint is <code>ephemeral</code> (served directly by an agent-initiated tunnel) or <code>edge</code> (served by an edge)</p>
|
|
283
|
+
</div>
|
|
284
|
+
</div>
|
|
285
|
+
</section>
|
|
286
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
287
|
+
<a name="updatedAt" class="tsd-anchor"></a>
|
|
288
|
+
<h3>updated<wbr>At</h3>
|
|
289
|
+
<div class="tsd-signature tsd-kind-icon">updated<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
290
|
+
<aside class="tsd-sources">
|
|
291
|
+
<ul>
|
|
292
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1076">datatypes.ts:1076</a></li>
|
|
293
|
+
</ul>
|
|
294
|
+
</aside>
|
|
295
|
+
<div class="tsd-comment tsd-typography">
|
|
296
|
+
<div class="lead">
|
|
297
|
+
<p>timestamp when the endpoint was updated in RFC 3339 format</p>
|
|
298
|
+
</div>
|
|
299
|
+
</div>
|
|
300
|
+
</section>
|
|
301
|
+
</section>
|
|
302
|
+
</div>
|
|
303
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
304
|
+
<nav class="tsd-navigation primary">
|
|
305
|
+
<ul>
|
|
306
|
+
<li class=" ">
|
|
307
|
+
<a href="../modules.html">Modules</a>
|
|
308
|
+
</li>
|
|
309
|
+
<li class=" tsd-kind-module">
|
|
310
|
+
<a href="../modules/client.html">client</a>
|
|
311
|
+
</li>
|
|
312
|
+
<li class="current tsd-kind-module">
|
|
313
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
314
|
+
</li>
|
|
315
|
+
<li class=" tsd-kind-module">
|
|
316
|
+
<a href="../modules/services.html">services</a>
|
|
317
|
+
</li>
|
|
318
|
+
</ul>
|
|
319
|
+
</nav>
|
|
320
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
321
|
+
<ul class="before-current">
|
|
322
|
+
</ul>
|
|
323
|
+
<ul class="current">
|
|
324
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
325
|
+
<a href="datatypes.Endpoint.html" class="tsd-kind-icon">Endpoint</a>
|
|
326
|
+
<ul>
|
|
327
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
328
|
+
<a href="datatypes.Endpoint.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
329
|
+
</li>
|
|
330
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
331
|
+
<a href="datatypes.Endpoint.html#domain" class="tsd-kind-icon">domain</a>
|
|
332
|
+
</li>
|
|
333
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
334
|
+
<a href="datatypes.Endpoint.html#edge" class="tsd-kind-icon">edge</a>
|
|
335
|
+
</li>
|
|
336
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
337
|
+
<a href="datatypes.Endpoint.html#hostport" class="tsd-kind-icon">hostport</a>
|
|
338
|
+
</li>
|
|
339
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
340
|
+
<a href="datatypes.Endpoint.html#id" class="tsd-kind-icon">id</a>
|
|
341
|
+
</li>
|
|
342
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
343
|
+
<a href="datatypes.Endpoint.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
344
|
+
</li>
|
|
345
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
346
|
+
<a href="datatypes.Endpoint.html#proto" class="tsd-kind-icon">proto</a>
|
|
347
|
+
</li>
|
|
348
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
349
|
+
<a href="datatypes.Endpoint.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a>
|
|
350
|
+
</li>
|
|
351
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
352
|
+
<a href="datatypes.Endpoint.html#region" class="tsd-kind-icon">region</a>
|
|
353
|
+
</li>
|
|
354
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
355
|
+
<a href="datatypes.Endpoint.html#tcpAddr" class="tsd-kind-icon">tcp<wbr>Addr</a>
|
|
356
|
+
</li>
|
|
357
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
358
|
+
<a href="datatypes.Endpoint.html#tunnel" class="tsd-kind-icon">tunnel</a>
|
|
359
|
+
</li>
|
|
360
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
361
|
+
<a href="datatypes.Endpoint.html#type" class="tsd-kind-icon">type</a>
|
|
362
|
+
</li>
|
|
363
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
364
|
+
<a href="datatypes.Endpoint.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a>
|
|
365
|
+
</li>
|
|
366
|
+
</ul>
|
|
367
|
+
</li>
|
|
368
|
+
</ul>
|
|
369
|
+
<ul class="after-current">
|
|
370
|
+
</ul>
|
|
371
|
+
</nav>
|
|
372
|
+
</div>
|
|
373
|
+
</div>
|
|
374
|
+
</div>
|
|
375
|
+
<footer class="with-border-bottom">
|
|
376
|
+
<div class="container">
|
|
377
|
+
<h2>Legend</h2>
|
|
378
|
+
<div class="tsd-legend-group">
|
|
379
|
+
<ul class="tsd-legend">
|
|
380
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
381
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
382
|
+
</ul>
|
|
383
|
+
<ul class="tsd-legend">
|
|
384
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
385
|
+
</ul>
|
|
386
|
+
</div>
|
|
387
|
+
</div>
|
|
388
|
+
</footer>
|
|
389
|
+
<div class="container tsd-generator">
|
|
390
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
391
|
+
</div>
|
|
392
|
+
<div class="overlay"></div>
|
|
393
|
+
<script src="../assets/js/main.js"></script>
|
|
394
|
+
</body>
|
|
395
|
+
</html>
|
|
@@ -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>EndpointBackend | @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,10 +58,10 @@
|
|
|
58
58
|
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
59
|
</li>
|
|
60
60
|
<li>
|
|
61
|
-
<a href="datatypes.
|
|
61
|
+
<a href="datatypes.EndpointBackend.html">EndpointBackend</a>
|
|
62
62
|
</li>
|
|
63
63
|
</ul>
|
|
64
|
-
<h1>Interface
|
|
64
|
+
<h1>Interface EndpointBackend</h1>
|
|
65
65
|
</div>
|
|
66
66
|
</div>
|
|
67
67
|
</header>
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
<h3>Hierarchy</h3>
|
|
73
73
|
<ul class="tsd-hierarchy">
|
|
74
74
|
<li>
|
|
75
|
-
<span class="target">
|
|
75
|
+
<span class="target">EndpointBackend</span>
|
|
76
76
|
</li>
|
|
77
77
|
</ul>
|
|
78
78
|
</section>
|
|
@@ -83,8 +83,8 @@
|
|
|
83
83
|
<section class="tsd-index-section ">
|
|
84
84
|
<h3>Properties</h3>
|
|
85
85
|
<ul class="tsd-index-list">
|
|
86
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
87
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointBackend.html#backend" class="tsd-kind-icon">backend</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointBackend.html#enabled" class="tsd-kind-icon">enabled</a></li>
|
|
88
88
|
</ul>
|
|
89
89
|
</section>
|
|
90
90
|
</div>
|
|
@@ -93,32 +93,32 @@
|
|
|
93
93
|
<section class="tsd-panel-group tsd-member-group ">
|
|
94
94
|
<h2>Properties</h2>
|
|
95
95
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
96
|
-
<a name="
|
|
97
|
-
<h3
|
|
98
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
96
|
+
<a name="backend" class="tsd-anchor"></a>
|
|
97
|
+
<h3>backend</h3>
|
|
98
|
+
<div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L675">datatypes.ts:675</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
105
105
|
<div class="lead">
|
|
106
|
-
<p
|
|
106
|
+
<p>backend to be used to back this endpoint</p>
|
|
107
107
|
</div>
|
|
108
108
|
</div>
|
|
109
109
|
</section>
|
|
110
110
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
111
|
-
<a name="
|
|
112
|
-
<h3>
|
|
113
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
111
|
+
<a name="enabled" class="tsd-anchor"></a>
|
|
112
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
|
|
113
|
+
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in datatypes.ts:
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L673">datatypes.ts:673</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
120
120
|
<div class="lead">
|
|
121
|
-
<p>
|
|
121
|
+
<p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
|
|
122
122
|
</div>
|
|
123
123
|
</div>
|
|
124
124
|
</section>
|
|
@@ -146,13 +146,13 @@
|
|
|
146
146
|
</ul>
|
|
147
147
|
<ul class="current">
|
|
148
148
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
149
|
-
<a href="datatypes.
|
|
149
|
+
<a href="datatypes.EndpointBackend.html" class="tsd-kind-icon">Endpoint<wbr>Backend</a>
|
|
150
150
|
<ul>
|
|
151
151
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
152
|
-
<a href="datatypes.
|
|
152
|
+
<a href="datatypes.EndpointBackend.html#backend" class="tsd-kind-icon">backend</a>
|
|
153
153
|
</li>
|
|
154
154
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
155
|
-
<a href="datatypes.
|
|
155
|
+
<a href="datatypes.EndpointBackend.html#enabled" class="tsd-kind-icon">enabled</a>
|
|
156
156
|
</li>
|
|
157
157
|
</ul>
|
|
158
158
|
</li>
|
|
@@ -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>EndpointBackendMutate | @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,10 +58,10 @@
|
|
|
58
58
|
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
59
|
</li>
|
|
60
60
|
<li>
|
|
61
|
-
<a href="datatypes.
|
|
61
|
+
<a href="datatypes.EndpointBackendMutate.html">EndpointBackendMutate</a>
|
|
62
62
|
</li>
|
|
63
63
|
</ul>
|
|
64
|
-
<h1>Interface
|
|
64
|
+
<h1>Interface EndpointBackendMutate</h1>
|
|
65
65
|
</div>
|
|
66
66
|
</div>
|
|
67
67
|
</header>
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
<h3>Hierarchy</h3>
|
|
73
73
|
<ul class="tsd-hierarchy">
|
|
74
74
|
<li>
|
|
75
|
-
<span class="target">
|
|
75
|
+
<span class="target">EndpointBackendMutate</span>
|
|
76
76
|
</li>
|
|
77
77
|
</ul>
|
|
78
78
|
</section>
|
|
@@ -83,8 +83,8 @@
|
|
|
83
83
|
<section class="tsd-index-section ">
|
|
84
84
|
<h3>Properties</h3>
|
|
85
85
|
<ul class="tsd-index-list">
|
|
86
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
87
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointBackendMutate.html#backendId" class="tsd-kind-icon">backend<wbr>Id</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointBackendMutate.html#enabled" class="tsd-kind-icon">enabled</a></li>
|
|
88
88
|
</ul>
|
|
89
89
|
</section>
|
|
90
90
|
</div>
|
|
@@ -93,32 +93,32 @@
|
|
|
93
93
|
<section class="tsd-panel-group tsd-member-group ">
|
|
94
94
|
<h2>Properties</h2>
|
|
95
95
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
96
|
-
<a name="
|
|
97
|
-
<h3
|
|
98
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
96
|
+
<a name="backendId" class="tsd-anchor"></a>
|
|
97
|
+
<h3>backend<wbr>Id</h3>
|
|
98
|
+
<div class="tsd-signature tsd-kind-icon">backend<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L682">datatypes.ts:682</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
105
105
|
<div class="lead">
|
|
106
|
-
<p
|
|
106
|
+
<p>backend to be used to back this endpoint</p>
|
|
107
107
|
</div>
|
|
108
108
|
</div>
|
|
109
109
|
</section>
|
|
110
110
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
111
|
-
<a name="
|
|
112
|
-
<h3>
|
|
113
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
111
|
+
<a name="enabled" class="tsd-anchor"></a>
|
|
112
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
|
|
113
|
+
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in datatypes.ts:
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L680">datatypes.ts:680</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
120
120
|
<div class="lead">
|
|
121
|
-
<p>
|
|
121
|
+
<p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
|
|
122
122
|
</div>
|
|
123
123
|
</div>
|
|
124
124
|
</section>
|
|
@@ -146,13 +146,13 @@
|
|
|
146
146
|
</ul>
|
|
147
147
|
<ul class="current">
|
|
148
148
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
149
|
-
<a href="datatypes.
|
|
149
|
+
<a href="datatypes.EndpointBackendMutate.html" class="tsd-kind-icon">Endpoint<wbr>Backend<wbr>Mutate</a>
|
|
150
150
|
<ul>
|
|
151
151
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
152
|
-
<a href="datatypes.
|
|
152
|
+
<a href="datatypes.EndpointBackendMutate.html#backendId" class="tsd-kind-icon">backend<wbr>Id</a>
|
|
153
153
|
</li>
|
|
154
154
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
155
|
-
<a href="datatypes.
|
|
155
|
+
<a href="datatypes.EndpointBackendMutate.html#enabled" class="tsd-kind-icon">enabled</a>
|
|
156
156
|
</li>
|
|
157
157
|
</ul>
|
|
158
158
|
</li>
|