@ngrok/ngrok-api 0.12.0 → 0.16.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/.github/workflows/ci.yml +28 -0
- package/CHANGELOG.md +14 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +76 -29
- package/docs/classes/services.APIKeys.html +6 -6
- package/docs/classes/services.AbuseReports.html +3 -3
- package/docs/classes/services.AgentIngresses.html +6 -6
- package/docs/classes/services.ApplicationSessions.html +4 -4
- package/docs/classes/services.ApplicationUsers.html +4 -4
- package/docs/classes/services.BotUsers.html +6 -6
- package/docs/classes/services.CertificateAuthorities.html +6 -6
- package/docs/classes/services.Credentials.html +6 -6
- package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
- package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
- package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
- package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +4 -4
- package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +6 -6
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +6 -6
- package/docs/classes/services.EdgesTLS.html +6 -6
- package/docs/classes/services.Endpoints.html +99 -3
- package/docs/classes/services.EventDestinations.html +6 -6
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +6 -6
- package/docs/classes/services.FailoverBackends.html +6 -6
- package/docs/classes/services.HTTPResponseBackends.html +6 -6
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.IPPolicies.html +6 -6
- package/docs/classes/services.IPPolicyRules.html +6 -6
- package/docs/classes/services.IPRestrictions.html +6 -6
- package/docs/classes/services.ReservedAddrs.html +6 -6
- package/docs/classes/services.ReservedDomains.html +8 -8
- package/docs/classes/services.SSHCertificateAuthorities.html +6 -6
- package/docs/classes/services.SSHCredentials.html +6 -6
- package/docs/classes/services.SSHHostCertificates.html +6 -6
- package/docs/classes/services.SSHUserCertificates.html +6 -6
- package/docs/classes/services.Secrets.html +359 -0
- package/docs/classes/services.StaticBackends.html +6 -6
- package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +4 -4
- package/docs/classes/services.TLSCertificates.html +6 -6
- package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +4 -4
- package/docs/classes/services.TunnelGroupBackends.html +6 -6
- package/docs/classes/services.TunnelSessions.html +6 -6
- package/docs/classes/services.Tunnels.html +3 -3
- package/docs/classes/services.Vaults.html +359 -0
- package/docs/classes/services.WeightedBackends.html +6 -6
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +7 -7
- package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
- 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.AgentIngress.html +10 -10
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
- package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
- package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
- package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
- package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUser.html +5 -5
- package/docs/interfaces/datatypes.BotUserCreate.html +2 -2
- package/docs/interfaces/datatypes.BotUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUserUpdate.html +3 -3
- package/docs/interfaces/datatypes.BrowserSession.html +3 -3
- 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 +8 -8
- package/docs/interfaces/datatypes.CredentialCreate.html +4 -4
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +2 -2
- package/docs/interfaces/datatypes.Endpoint.html +266 -15
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointCreate.html +276 -0
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- package/docs/interfaces/datatypes.EndpointListArgs.html +204 -0
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
- package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointUpdate.html +276 -0
- package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +3 -3
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +3 -3
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- 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 +4 -4
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +5 -5
- package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +7 -7
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +21 -21
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +5 -5
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
- 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.IdentityProvider.html +2 -2
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +4 -4
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +12 -12
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -6
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- 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 +8 -8
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
- 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.Secret.html +338 -0
- package/docs/interfaces/datatypes.SecretCreate.html +243 -0
- package/docs/interfaces/datatypes.SecretList.html +200 -0
- package/docs/interfaces/datatypes.SecretUpdate.html +243 -0
- package/docs/interfaces/datatypes.StaticBackend.html +7 -7
- package/docs/interfaces/datatypes.StaticBackendCreate.html +4 -4
- package/docs/interfaces/datatypes.StaticBackendList.html +3 -3
- package/docs/interfaces/datatypes.StaticBackendTLS.html +1 -1
- package/docs/interfaces/datatypes.StaticBackendUpdate.html +5 -5
- package/docs/interfaces/datatypes.TCPEdge.html +9 -9
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +6 -6
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +7 -7
- 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 +11 -11
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +8 -8
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +9 -9
- package/docs/interfaces/datatypes.Tunnel.html +11 -11
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +10 -10
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +6 -6
- package/docs/interfaces/datatypes.Vault.html +319 -0
- package/docs/interfaces/datatypes.VaultCreate.html +205 -0
- package/docs/interfaces/datatypes.VaultList.html +200 -0
- package/docs/interfaces/datatypes.VaultUpdate.html +224 -0
- package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +44 -0
- package/docs/modules/services.html +8 -0
- package/lib/client.d.ts +11 -0
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +6 -1
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +163 -4
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +72 -0
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +263 -25
- package/lib/services.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +23 -1
- package/src/datatypes.ts +174 -4
- package/src/services.ts +234 -2
|
@@ -0,0 +1,276 @@
|
|
|
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>EndpointCreate | @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.EndpointCreate.html">EndpointCreate</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface EndpointCreate</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">EndpointCreate</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.EndpointCreate.html#bindings" class="tsd-kind-icon">bindings</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCreate.html#description" class="tsd-kind-icon">description</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCreate.html#poolingEnabled" class="tsd-kind-icon">pooling<wbr>Enabled</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCreate.html#trafficPolicy" class="tsd-kind-icon">traffic<wbr>Policy</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCreate.html#type" class="tsd-kind-icon">type</a></li>
|
|
92
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCreate.html#url" class="tsd-kind-icon">url</a></li>
|
|
93
|
+
</ul>
|
|
94
|
+
</section>
|
|
95
|
+
</div>
|
|
96
|
+
</section>
|
|
97
|
+
</section>
|
|
98
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
99
|
+
<h2>Properties</h2>
|
|
100
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
101
|
+
<a name="bindings" class="tsd-anchor"></a>
|
|
102
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> bindings</h3>
|
|
103
|
+
<div class="tsd-signature tsd-kind-icon">bindings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
104
|
+
<aside class="tsd-sources">
|
|
105
|
+
<ul>
|
|
106
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1513">datatypes.ts:1513</a></li>
|
|
107
|
+
</ul>
|
|
108
|
+
</aside>
|
|
109
|
+
<div class="tsd-comment tsd-typography">
|
|
110
|
+
<div class="lead">
|
|
111
|
+
<p>the bindings associated with this endpoint</p>
|
|
112
|
+
</div>
|
|
113
|
+
</div>
|
|
114
|
+
</section>
|
|
115
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
116
|
+
<a name="description" class="tsd-anchor"></a>
|
|
117
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
118
|
+
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
119
|
+
<aside class="tsd-sources">
|
|
120
|
+
<ul>
|
|
121
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1509">datatypes.ts:1509</a></li>
|
|
122
|
+
</ul>
|
|
123
|
+
</aside>
|
|
124
|
+
<div class="tsd-comment tsd-typography">
|
|
125
|
+
<div class="lead">
|
|
126
|
+
<p>user-supplied description of the associated tunnel</p>
|
|
127
|
+
</div>
|
|
128
|
+
</div>
|
|
129
|
+
</section>
|
|
130
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
131
|
+
<a name="metadata" class="tsd-anchor"></a>
|
|
132
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
133
|
+
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
134
|
+
<aside class="tsd-sources">
|
|
135
|
+
<ul>
|
|
136
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1511">datatypes.ts:1511</a></li>
|
|
137
|
+
</ul>
|
|
138
|
+
</aside>
|
|
139
|
+
<div class="tsd-comment tsd-typography">
|
|
140
|
+
<div class="lead">
|
|
141
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
|
142
|
+
</div>
|
|
143
|
+
</div>
|
|
144
|
+
</section>
|
|
145
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
146
|
+
<a name="poolingEnabled" class="tsd-anchor"></a>
|
|
147
|
+
<h3>pooling<wbr>Enabled</h3>
|
|
148
|
+
<div class="tsd-signature tsd-kind-icon">pooling<wbr>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
149
|
+
<aside class="tsd-sources">
|
|
150
|
+
<ul>
|
|
151
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1514">datatypes.ts:1514</a></li>
|
|
152
|
+
</ul>
|
|
153
|
+
</aside>
|
|
154
|
+
</section>
|
|
155
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
156
|
+
<a name="trafficPolicy" class="tsd-anchor"></a>
|
|
157
|
+
<h3>traffic<wbr>Policy</h3>
|
|
158
|
+
<div class="tsd-signature tsd-kind-icon">traffic<wbr>Policy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
159
|
+
<aside class="tsd-sources">
|
|
160
|
+
<ul>
|
|
161
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1507">datatypes.ts:1507</a></li>
|
|
162
|
+
</ul>
|
|
163
|
+
</aside>
|
|
164
|
+
<div class="tsd-comment tsd-typography">
|
|
165
|
+
<div class="lead">
|
|
166
|
+
<p>The traffic policy attached to this endpoint</p>
|
|
167
|
+
</div>
|
|
168
|
+
</div>
|
|
169
|
+
</section>
|
|
170
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
171
|
+
<a name="type" class="tsd-anchor"></a>
|
|
172
|
+
<h3>type</h3>
|
|
173
|
+
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
174
|
+
<aside class="tsd-sources">
|
|
175
|
+
<ul>
|
|
176
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1505">datatypes.ts:1505</a></li>
|
|
177
|
+
</ul>
|
|
178
|
+
</aside>
|
|
179
|
+
<div class="tsd-comment tsd-typography">
|
|
180
|
+
<div class="lead">
|
|
181
|
+
<p>Type of endpoint. Only 'cloud' is currently supported (represents a cloud endpoint). Defaults to 'cloud' if not specified.</p>
|
|
182
|
+
</div>
|
|
183
|
+
</div>
|
|
184
|
+
</section>
|
|
185
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
186
|
+
<a name="url" class="tsd-anchor"></a>
|
|
187
|
+
<h3>url</h3>
|
|
188
|
+
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
189
|
+
<aside class="tsd-sources">
|
|
190
|
+
<ul>
|
|
191
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1503">datatypes.ts:1503</a></li>
|
|
192
|
+
</ul>
|
|
193
|
+
</aside>
|
|
194
|
+
<div class="tsd-comment tsd-typography">
|
|
195
|
+
<div class="lead">
|
|
196
|
+
<p>the url of the endpoint</p>
|
|
197
|
+
</div>
|
|
198
|
+
</div>
|
|
199
|
+
</section>
|
|
200
|
+
</section>
|
|
201
|
+
</div>
|
|
202
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
203
|
+
<nav class="tsd-navigation primary">
|
|
204
|
+
<ul>
|
|
205
|
+
<li class=" ">
|
|
206
|
+
<a href="../modules.html">Modules</a>
|
|
207
|
+
</li>
|
|
208
|
+
<li class=" tsd-kind-module">
|
|
209
|
+
<a href="../modules/client.html">client</a>
|
|
210
|
+
</li>
|
|
211
|
+
<li class="current tsd-kind-module">
|
|
212
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
213
|
+
</li>
|
|
214
|
+
<li class=" tsd-kind-module">
|
|
215
|
+
<a href="../modules/services.html">services</a>
|
|
216
|
+
</li>
|
|
217
|
+
</ul>
|
|
218
|
+
</nav>
|
|
219
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
220
|
+
<ul class="before-current">
|
|
221
|
+
</ul>
|
|
222
|
+
<ul class="current">
|
|
223
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
224
|
+
<a href="datatypes.EndpointCreate.html" class="tsd-kind-icon">Endpoint<wbr>Create</a>
|
|
225
|
+
<ul>
|
|
226
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
227
|
+
<a href="datatypes.EndpointCreate.html#bindings" class="tsd-kind-icon">bindings</a>
|
|
228
|
+
</li>
|
|
229
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
230
|
+
<a href="datatypes.EndpointCreate.html#description" class="tsd-kind-icon">description</a>
|
|
231
|
+
</li>
|
|
232
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
233
|
+
<a href="datatypes.EndpointCreate.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
234
|
+
</li>
|
|
235
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
236
|
+
<a href="datatypes.EndpointCreate.html#poolingEnabled" class="tsd-kind-icon">pooling<wbr>Enabled</a>
|
|
237
|
+
</li>
|
|
238
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
239
|
+
<a href="datatypes.EndpointCreate.html#trafficPolicy" class="tsd-kind-icon">traffic<wbr>Policy</a>
|
|
240
|
+
</li>
|
|
241
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
242
|
+
<a href="datatypes.EndpointCreate.html#type" class="tsd-kind-icon">type</a>
|
|
243
|
+
</li>
|
|
244
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
245
|
+
<a href="datatypes.EndpointCreate.html#url" class="tsd-kind-icon">url</a>
|
|
246
|
+
</li>
|
|
247
|
+
</ul>
|
|
248
|
+
</li>
|
|
249
|
+
</ul>
|
|
250
|
+
<ul class="after-current">
|
|
251
|
+
</ul>
|
|
252
|
+
</nav>
|
|
253
|
+
</div>
|
|
254
|
+
</div>
|
|
255
|
+
</div>
|
|
256
|
+
<footer class="with-border-bottom">
|
|
257
|
+
<div class="container">
|
|
258
|
+
<h2>Legend</h2>
|
|
259
|
+
<div class="tsd-legend-group">
|
|
260
|
+
<ul class="tsd-legend">
|
|
261
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
262
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
263
|
+
</ul>
|
|
264
|
+
<ul class="tsd-legend">
|
|
265
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
266
|
+
</ul>
|
|
267
|
+
</div>
|
|
268
|
+
</div>
|
|
269
|
+
</footer>
|
|
270
|
+
<div class="container tsd-generator">
|
|
271
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
272
|
+
</div>
|
|
273
|
+
<div class="overlay"></div>
|
|
274
|
+
<script src="../assets/js/main.js"></script>
|
|
275
|
+
</body>
|
|
276
|
+
</html>
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L762">datatypes.ts:762</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L764">datatypes.ts:764</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L769">datatypes.ts:769</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L771">datatypes.ts:771</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">endpoints<span class="tsd-signature-symbol">:</span> <a href="datatypes.Endpoint.html" class="tsd-signature-type" data-tsd-kind="Interface">Endpoint</a><span class="tsd-signature-symbol">[]</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1494">datatypes.ts:1494</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1498">datatypes.ts:1498</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1496">datatypes.ts:1496</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -0,0 +1,204 @@
|
|
|
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>EndpointListArgs | @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.EndpointListArgs.html">EndpointListArgs</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface EndpointListArgs</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">EndpointListArgs</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.EndpointListArgs.html#beforeId" class="tsd-kind-icon">before<wbr>Id</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointListArgs.html#ids" class="tsd-kind-icon">ids</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointListArgs.html#limit" class="tsd-kind-icon">limit</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointListArgs.html#urls" class="tsd-kind-icon">urls</a></li>
|
|
90
|
+
</ul>
|
|
91
|
+
</section>
|
|
92
|
+
</div>
|
|
93
|
+
</section>
|
|
94
|
+
</section>
|
|
95
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
96
|
+
<h2>Properties</h2>
|
|
97
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
98
|
+
<a name="beforeId" class="tsd-anchor"></a>
|
|
99
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> before<wbr>Id</h3>
|
|
100
|
+
<div class="tsd-signature tsd-kind-icon">before<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
101
|
+
<aside class="tsd-sources">
|
|
102
|
+
<ul>
|
|
103
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1518">datatypes.ts:1518</a></li>
|
|
104
|
+
</ul>
|
|
105
|
+
</aside>
|
|
106
|
+
</section>
|
|
107
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
108
|
+
<a name="ids" class="tsd-anchor"></a>
|
|
109
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ids</h3>
|
|
110
|
+
<div class="tsd-signature tsd-kind-icon">ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
111
|
+
<aside class="tsd-sources">
|
|
112
|
+
<ul>
|
|
113
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1520">datatypes.ts:1520</a></li>
|
|
114
|
+
</ul>
|
|
115
|
+
</aside>
|
|
116
|
+
</section>
|
|
117
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
118
|
+
<a name="limit" class="tsd-anchor"></a>
|
|
119
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3>
|
|
120
|
+
<div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
121
|
+
<aside class="tsd-sources">
|
|
122
|
+
<ul>
|
|
123
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1519">datatypes.ts:1519</a></li>
|
|
124
|
+
</ul>
|
|
125
|
+
</aside>
|
|
126
|
+
</section>
|
|
127
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
128
|
+
<a name="urls" class="tsd-anchor"></a>
|
|
129
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> urls</h3>
|
|
130
|
+
<div class="tsd-signature tsd-kind-icon">urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
131
|
+
<aside class="tsd-sources">
|
|
132
|
+
<ul>
|
|
133
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1521">datatypes.ts:1521</a></li>
|
|
134
|
+
</ul>
|
|
135
|
+
</aside>
|
|
136
|
+
</section>
|
|
137
|
+
</section>
|
|
138
|
+
</div>
|
|
139
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
140
|
+
<nav class="tsd-navigation primary">
|
|
141
|
+
<ul>
|
|
142
|
+
<li class=" ">
|
|
143
|
+
<a href="../modules.html">Modules</a>
|
|
144
|
+
</li>
|
|
145
|
+
<li class=" tsd-kind-module">
|
|
146
|
+
<a href="../modules/client.html">client</a>
|
|
147
|
+
</li>
|
|
148
|
+
<li class="current tsd-kind-module">
|
|
149
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
150
|
+
</li>
|
|
151
|
+
<li class=" tsd-kind-module">
|
|
152
|
+
<a href="../modules/services.html">services</a>
|
|
153
|
+
</li>
|
|
154
|
+
</ul>
|
|
155
|
+
</nav>
|
|
156
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
157
|
+
<ul class="before-current">
|
|
158
|
+
</ul>
|
|
159
|
+
<ul class="current">
|
|
160
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
161
|
+
<a href="datatypes.EndpointListArgs.html" class="tsd-kind-icon">Endpoint<wbr>List<wbr>Args</a>
|
|
162
|
+
<ul>
|
|
163
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
164
|
+
<a href="datatypes.EndpointListArgs.html#beforeId" class="tsd-kind-icon">before<wbr>Id</a>
|
|
165
|
+
</li>
|
|
166
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
167
|
+
<a href="datatypes.EndpointListArgs.html#ids" class="tsd-kind-icon">ids</a>
|
|
168
|
+
</li>
|
|
169
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
170
|
+
<a href="datatypes.EndpointListArgs.html#limit" class="tsd-kind-icon">limit</a>
|
|
171
|
+
</li>
|
|
172
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
173
|
+
<a href="datatypes.EndpointListArgs.html#urls" class="tsd-kind-icon">urls</a>
|
|
174
|
+
</li>
|
|
175
|
+
</ul>
|
|
176
|
+
</li>
|
|
177
|
+
</ul>
|
|
178
|
+
<ul class="after-current">
|
|
179
|
+
</ul>
|
|
180
|
+
</nav>
|
|
181
|
+
</div>
|
|
182
|
+
</div>
|
|
183
|
+
</div>
|
|
184
|
+
<footer class="with-border-bottom">
|
|
185
|
+
<div class="container">
|
|
186
|
+
<h2>Legend</h2>
|
|
187
|
+
<div class="tsd-legend-group">
|
|
188
|
+
<ul class="tsd-legend">
|
|
189
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
190
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
191
|
+
</ul>
|
|
192
|
+
<ul class="tsd-legend">
|
|
193
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
194
|
+
</ul>
|
|
195
|
+
</div>
|
|
196
|
+
</div>
|
|
197
|
+
</footer>
|
|
198
|
+
<div class="container tsd-generator">
|
|
199
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
200
|
+
</div>
|
|
201
|
+
<div class="overlay"></div>
|
|
202
|
+
<script src="../assets/js/main.js"></script>
|
|
203
|
+
</body>
|
|
204
|
+
</html>
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L716">datatypes.ts:716</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L714">datatypes.ts:714</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Authority<wbr>Ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L723">datatypes.ts:723</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L721">datatypes.ts:721</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|