@ngrok/ngrok-api 0.0.9 → 0.3.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.
Files changed (218) hide show
  1. package/.eslintrc.js +4 -1
  2. package/CHANGELOG.md +34 -0
  3. package/README.md +148 -2
  4. package/docs/CNAME +1 -0
  5. package/docs/assets/css/main.css +2660 -0
  6. package/docs/assets/images/icons.png +0 -0
  7. package/docs/assets/images/icons@2x.png +0 -0
  8. package/docs/assets/images/widgets.png +0 -0
  9. package/docs/assets/images/widgets@2x.png +0 -0
  10. package/docs/assets/js/main.js +248 -0
  11. package/docs/assets/js/search.js +1 -0
  12. package/docs/classes/client.Ngrok.html +681 -0
  13. package/docs/classes/services.APIKeys.html +453 -0
  14. package/docs/classes/services.AbuseReports.html +360 -0
  15. package/docs/classes/services.AgentIngresses.html +442 -0
  16. package/docs/classes/services.CertificateAuthorities.html +453 -0
  17. package/docs/classes/services.Credentials.html +452 -0
  18. package/docs/classes/services.EndpointCircuitBreakerModule.html +369 -0
  19. package/docs/classes/services.EndpointCompressionModule.html +369 -0
  20. package/docs/classes/services.EndpointConfigurations.html +451 -0
  21. package/docs/classes/services.EndpointIPPolicyModule.html +369 -0
  22. package/docs/classes/services.EndpointLoggingModule.html +369 -0
  23. package/docs/classes/services.EndpointMutualTLSModule.html +369 -0
  24. package/docs/classes/services.EndpointOAuthModule.html +369 -0
  25. package/docs/classes/services.EndpointOIDCModule.html +369 -0
  26. package/docs/classes/services.EndpointRequestHeadersModule.html +369 -0
  27. package/docs/classes/services.EndpointResponseHeadersModule.html +369 -0
  28. package/docs/classes/services.EndpointSAMLModule.html +369 -0
  29. package/docs/classes/services.EndpointTLSTerminationModule.html +369 -0
  30. package/docs/classes/services.EndpointWebhookValidationModule.html +369 -0
  31. package/docs/classes/services.EventDestinations.html +442 -0
  32. package/docs/classes/services.EventSources.html +448 -0
  33. package/docs/classes/services.EventStreams.html +442 -0
  34. package/docs/classes/services.EventSubscriptions.html +442 -0
  35. package/docs/classes/services.IPPolicies.html +452 -0
  36. package/docs/classes/services.IPPolicyRules.html +450 -0
  37. package/docs/classes/services.IPRestrictions.html +454 -0
  38. package/docs/classes/services.ReservedAddrs.html +483 -0
  39. package/docs/classes/services.ReservedDomains.html +580 -0
  40. package/docs/classes/services.SSHCertificateAuthorities.html +450 -0
  41. package/docs/classes/services.SSHCredentials.html +450 -0
  42. package/docs/classes/services.SSHHostCertificates.html +451 -0
  43. package/docs/classes/services.SSHUserCertificates.html +451 -0
  44. package/docs/classes/services.TLSCertificates.html +453 -0
  45. package/docs/classes/services.TunnelSessions.html +451 -0
  46. package/docs/classes/services.Tunnels.html +322 -0
  47. package/docs/index.html +239 -0
  48. package/docs/interfaces/client.NgrokConfig.html +179 -0
  49. package/docs/interfaces/datatypes.APIKey.html +262 -0
  50. package/docs/interfaces/datatypes.APIKeyCreate.html +186 -0
  51. package/docs/interfaces/datatypes.APIKeyList.html +205 -0
  52. package/docs/interfaces/datatypes.APIKeyUpdate.html +200 -0
  53. package/docs/interfaces/datatypes.AWSAuth.html +186 -0
  54. package/docs/interfaces/datatypes.AWSCredentials.html +186 -0
  55. package/docs/interfaces/datatypes.AWSRole.html +167 -0
  56. package/docs/interfaces/datatypes.AbuseReport.html +281 -0
  57. package/docs/interfaces/datatypes.AbuseReportCreate.html +186 -0
  58. package/docs/interfaces/datatypes.AbuseReportHostname.html +186 -0
  59. package/docs/interfaces/datatypes.AgentIngress.html +300 -0
  60. package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
  61. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  62. package/docs/interfaces/datatypes.AgentIngressUpdate.html +200 -0
  63. package/docs/interfaces/datatypes.CertificateAuthority.html +357 -0
  64. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +205 -0
  65. package/docs/interfaces/datatypes.CertificateAuthorityList.html +205 -0
  66. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +200 -0
  67. package/docs/interfaces/datatypes.Credential.html +281 -0
  68. package/docs/interfaces/datatypes.CredentialCreate.html +205 -0
  69. package/docs/interfaces/datatypes.CredentialList.html +205 -0
  70. package/docs/interfaces/datatypes.CredentialUpdate.html +219 -0
  71. package/docs/interfaces/datatypes.Empty.html +130 -0
  72. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +262 -0
  73. package/docs/interfaces/datatypes.EndpointCircuitBreakerReplace.html +176 -0
  74. package/docs/interfaces/datatypes.EndpointCompression.html +167 -0
  75. package/docs/interfaces/datatypes.EndpointCompressionReplace.html +176 -0
  76. package/docs/interfaces/datatypes.EndpointConfiguration.html +490 -0
  77. package/docs/interfaces/datatypes.EndpointConfigurationCreate.html +433 -0
  78. package/docs/interfaces/datatypes.EndpointConfigurationList.html +205 -0
  79. package/docs/interfaces/datatypes.EndpointConfigurationUpdate.html +433 -0
  80. package/docs/interfaces/datatypes.EndpointIPPolicy.html +181 -0
  81. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +186 -0
  82. package/docs/interfaces/datatypes.EndpointIPPolicyReplace.html +176 -0
  83. package/docs/interfaces/datatypes.EndpointLogging.html +186 -0
  84. package/docs/interfaces/datatypes.EndpointLoggingMutate.html +186 -0
  85. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +176 -0
  86. package/docs/interfaces/datatypes.EndpointMutualTLS.html +186 -0
  87. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +186 -0
  88. package/docs/interfaces/datatypes.EndpointMutualTLSReplace.html +176 -0
  89. package/docs/interfaces/datatypes.EndpointOAuth.html +281 -0
  90. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +243 -0
  91. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +281 -0
  92. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +243 -0
  93. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +243 -0
  94. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +224 -0
  95. package/docs/interfaces/datatypes.EndpointOAuthReplace.html +176 -0
  96. package/docs/interfaces/datatypes.EndpointOIDC.html +319 -0
  97. package/docs/interfaces/datatypes.EndpointOIDCReplace.html +176 -0
  98. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +205 -0
  99. package/docs/interfaces/datatypes.EndpointRequestHeadersReplace.html +176 -0
  100. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +205 -0
  101. package/docs/interfaces/datatypes.EndpointResponseHeadersReplace.html +176 -0
  102. package/docs/interfaces/datatypes.EndpointSAML.html +433 -0
  103. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +338 -0
  104. package/docs/interfaces/datatypes.EndpointSAMLReplace.html +176 -0
  105. package/docs/interfaces/datatypes.EndpointTLSTermination.html +205 -0
  106. package/docs/interfaces/datatypes.EndpointTLSTerminationReplace.html +176 -0
  107. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +205 -0
  108. package/docs/interfaces/datatypes.EndpointWebhookValidationReplace.html +176 -0
  109. package/docs/interfaces/datatypes.Error.html +204 -0
  110. package/docs/interfaces/datatypes.EventDestination.html +281 -0
  111. package/docs/interfaces/datatypes.EventDestinationCreate.html +224 -0
  112. package/docs/interfaces/datatypes.EventDestinationList.html +205 -0
  113. package/docs/interfaces/datatypes.EventDestinationUpdate.html +243 -0
  114. package/docs/interfaces/datatypes.EventSource.html +186 -0
  115. package/docs/interfaces/datatypes.EventSourceCreate.html +186 -0
  116. package/docs/interfaces/datatypes.EventSourceItem.html +193 -0
  117. package/docs/interfaces/datatypes.EventSourceList.html +186 -0
  118. package/docs/interfaces/datatypes.EventSourcePaging.html +174 -0
  119. package/docs/interfaces/datatypes.EventSourceReplace.html +167 -0
  120. package/docs/interfaces/datatypes.EventSourceUpdate.html +186 -0
  121. package/docs/interfaces/datatypes.EventStream.html +319 -0
  122. package/docs/interfaces/datatypes.EventStreamCreate.html +262 -0
  123. package/docs/interfaces/datatypes.EventStreamList.html +205 -0
  124. package/docs/interfaces/datatypes.EventStreamUpdate.html +262 -0
  125. package/docs/interfaces/datatypes.EventSubscription.html +281 -0
  126. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +224 -0
  127. package/docs/interfaces/datatypes.EventSubscriptionList.html +205 -0
  128. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +243 -0
  129. package/docs/interfaces/datatypes.EventTarget.html +205 -0
  130. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +186 -0
  131. package/docs/interfaces/datatypes.EventTargetFirehose.html +186 -0
  132. package/docs/interfaces/datatypes.EventTargetKinesis.html +186 -0
  133. package/docs/interfaces/datatypes.IPPolicy.html +262 -0
  134. package/docs/interfaces/datatypes.IPPolicyCreate.html +205 -0
  135. package/docs/interfaces/datatypes.IPPolicyList.html +205 -0
  136. package/docs/interfaces/datatypes.IPPolicyRule.html +281 -0
  137. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +224 -0
  138. package/docs/interfaces/datatypes.IPPolicyRuleList.html +205 -0
  139. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +219 -0
  140. package/docs/interfaces/datatypes.IPPolicyUpdate.html +200 -0
  141. package/docs/interfaces/datatypes.IPRestriction.html +300 -0
  142. package/docs/interfaces/datatypes.IPRestrictionCreate.html +243 -0
  143. package/docs/interfaces/datatypes.IPRestrictionList.html +205 -0
  144. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +238 -0
  145. package/docs/interfaces/datatypes.Item.html +167 -0
  146. package/docs/interfaces/datatypes.Paging.html +176 -0
  147. package/docs/interfaces/datatypes.Ref.html +186 -0
  148. package/docs/interfaces/datatypes.ReservedAddr.html +300 -0
  149. package/docs/interfaces/datatypes.ReservedAddrCreate.html +224 -0
  150. package/docs/interfaces/datatypes.ReservedAddrList.html +205 -0
  151. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +219 -0
  152. package/docs/interfaces/datatypes.ReservedDomain.html +414 -0
  153. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +224 -0
  154. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +186 -0
  155. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +186 -0
  156. package/docs/interfaces/datatypes.ReservedDomainCreate.html +300 -0
  157. package/docs/interfaces/datatypes.ReservedDomainList.html +205 -0
  158. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +276 -0
  159. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +281 -0
  160. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +243 -0
  161. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +205 -0
  162. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +200 -0
  163. package/docs/interfaces/datatypes.SSHCredential.html +281 -0
  164. package/docs/interfaces/datatypes.SSHCredentialCreate.html +224 -0
  165. package/docs/interfaces/datatypes.SSHCredentialList.html +205 -0
  166. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +219 -0
  167. package/docs/interfaces/datatypes.SSHHostCertificate.html +376 -0
  168. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +281 -0
  169. package/docs/interfaces/datatypes.SSHHostCertificateList.html +205 -0
  170. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +200 -0
  171. package/docs/interfaces/datatypes.SSHUserCertificate.html +414 -0
  172. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +319 -0
  173. package/docs/interfaces/datatypes.SSHUserCertificateList.html +205 -0
  174. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +200 -0
  175. package/docs/interfaces/datatypes.TLSCertificate.html +547 -0
  176. package/docs/interfaces/datatypes.TLSCertificateCreate.html +224 -0
  177. package/docs/interfaces/datatypes.TLSCertificateList.html +205 -0
  178. package/docs/interfaces/datatypes.TLSCertificateSANs.html +186 -0
  179. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +200 -0
  180. package/docs/interfaces/datatypes.Tunnel.html +281 -0
  181. package/docs/interfaces/datatypes.TunnelList.html +205 -0
  182. package/docs/interfaces/datatypes.TunnelSession.html +338 -0
  183. package/docs/interfaces/datatypes.TunnelSessionList.html +205 -0
  184. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +162 -0
  185. package/docs/modules/client.html +137 -0
  186. package/docs/modules/datatypes.html +668 -0
  187. package/docs/modules/services.html +260 -0
  188. package/docs/modules.html +119 -0
  189. package/lib/client.d.ts +145 -0
  190. package/lib/client.d.ts.map +1 -0
  191. package/lib/client.js +102 -0
  192. package/lib/client.js.map +1 -0
  193. package/lib/{types.d.ts → datatypes.d.ts} +620 -816
  194. package/lib/datatypes.d.ts.map +1 -0
  195. package/lib/{types.js → datatypes.js} +1 -1
  196. package/lib/datatypes.js.map +1 -0
  197. package/lib/index.d.ts +3 -314
  198. package/lib/index.d.ts.map +1 -0
  199. package/lib/index.js +25 -887
  200. package/lib/index.js.map +1 -1
  201. package/lib/services.d.ts +773 -0
  202. package/lib/services.d.ts.map +1 -0
  203. package/lib/services.js +2761 -0
  204. package/lib/services.js.map +1 -0
  205. package/lib/util.d.ts +5 -0
  206. package/lib/util.d.ts.map +1 -0
  207. package/lib/util.js +53 -0
  208. package/lib/util.js.map +1 -0
  209. package/package.json +12 -3
  210. package/src/client.ts +265 -0
  211. package/src/{types.ts → datatypes.ts} +648 -869
  212. package/src/index.ts +2 -616
  213. package/src/services.ts +2560 -0
  214. package/src/util.ts +48 -0
  215. package/test/apikey.test.js +44 -30
  216. package/test/endpointConfigurations.test.js +38 -34
  217. package/tsconfig.json +17 -7
  218. package/lib/types.js.map +0 -1
package/docs/classes/services.TunnelSessions.html ADDED
@@ -0,0 +1,451 @@
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>TunnelSessions | @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/services.html">services</a>
59
+ </li>
60
+ <li>
61
+ <a href="services.TunnelSessions.html">TunnelSessions</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Class TunnelSessions</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-comment">
72
+ <div class="tsd-comment tsd-typography">
73
+ <div class="lead">
74
+ <p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
75
+ sessions that are running and connected to the ngrok service. Each tunnel
76
+ session can include one or more Tunnels.</p>
77
+ </div>
78
+ </div>
79
+ </section>
80
+ <section class="tsd-panel tsd-hierarchy">
81
+ <h3>Hierarchy</h3>
82
+ <ul class="tsd-hierarchy">
83
+ <li>
84
+ <span class="target">TunnelSessions</span>
85
+ </li>
86
+ </ul>
87
+ </section>
88
+ <section class="tsd-panel-group tsd-index-group">
89
+ <h2>Index</h2>
90
+ <section class="tsd-panel tsd-index-panel">
91
+ <div class="tsd-index-content">
92
+ <section class="tsd-index-section ">
93
+ <h3>Constructors</h3>
94
+ <ul class="tsd-index-list">
95
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.TunnelSessions.html#constructor" class="tsd-kind-icon">constructor</a></li>
96
+ </ul>
97
+ </section>
98
+ <section class="tsd-index-section ">
99
+ <h3>Methods</h3>
100
+ <ul class="tsd-index-list">
101
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#get" class="tsd-kind-icon">get</a></li>
102
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#list" class="tsd-kind-icon">list</a></li>
103
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#restart" class="tsd-kind-icon">restart</a></li>
104
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#stop" class="tsd-kind-icon">stop</a></li>
105
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#update" class="tsd-kind-icon">update</a></li>
106
+ </ul>
107
+ </section>
108
+ </div>
109
+ </section>
110
+ </section>
111
+ <section class="tsd-panel-group tsd-member-group ">
112
+ <h2>Constructors</h2>
113
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
114
+ <a name="constructor" class="tsd-anchor"></a>
115
+ <h3>constructor</h3>
116
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
117
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Tunnel<wbr>Sessions<span class="tsd-signature-symbol">(</span>httpClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Wretcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="services.TunnelSessions.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelSessions</a></li>
118
+ </ul>
119
+ <ul class="tsd-descriptions">
120
+ <li class="tsd-description">
121
+ <aside class="tsd-sources">
122
+ <ul>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L2419">services.ts:2419</a></li>
124
+ </ul>
125
+ </aside>
126
+ <div class="tsd-comment tsd-typography">
127
+ <div class="lead">
128
+ <p>Do not construct this object directly, use the <code>tunnelSessions</code> property of an <code>Ngrok</code> client object instead.</p>
129
+ </div>
130
+ </div>
131
+ <h4 class="tsd-parameters-title">Parameters</h4>
132
+ <ul class="tsd-parameters">
133
+ <li>
134
+ <h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
135
+ </li>
136
+ </ul>
137
+ <h4 class="tsd-returns-title">Returns <a href="services.TunnelSessions.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelSessions</a></h4>
138
+ </li>
139
+ </ul>
140
+ </section>
141
+ </section>
142
+ <section class="tsd-panel-group tsd-member-group ">
143
+ <h2>Methods</h2>
144
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
145
+ <a name="get" class="tsd-anchor"></a>
146
+ <h3>get</h3>
147
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
148
+ <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">&gt;</span></li>
149
+ </ul>
150
+ <ul class="tsd-descriptions">
151
+ <li class="tsd-description">
152
+ <aside class="tsd-sources">
153
+ <ul>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L2467">services.ts:2467</a></li>
155
+ </ul>
156
+ </aside>
157
+ <div class="tsd-comment tsd-typography">
158
+ <div class="lead">
159
+ <p>Get the detailed status of a tunnel session by ID</p>
160
+ </div>
161
+ </div>
162
+ <h4 class="tsd-parameters-title">Parameters</h4>
163
+ <ul class="tsd-parameters">
164
+ <li>
165
+ <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
166
+ </li>
167
+ </ul>
168
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">&gt;</span></h4>
169
+ </li>
170
+ </ul>
171
+ </section>
172
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
173
+ <a name="list" class="tsd-anchor"></a>
174
+ <h3>list</h3>
175
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
176
+ <li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
177
+ </ul>
178
+ <ul class="tsd-descriptions">
179
+ <li class="tsd-description">
180
+ <aside class="tsd-sources">
181
+ <ul>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L2425">services.ts:2425</a></li>
183
+ </ul>
184
+ </aside>
185
+ <div class="tsd-comment tsd-typography">
186
+ <div class="lead">
187
+ <p>List all online tunnel sessions running on this account.</p>
188
+ </div>
189
+ </div>
190
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
191
+ </li>
192
+ </ul>
193
+ </section>
194
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
195
+ <a name="restart" class="tsd-anchor"></a>
196
+ <h3>restart</h3>
197
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
198
+ <li class="tsd-signature tsd-kind-icon">restart<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
199
+ </ul>
200
+ <ul class="tsd-descriptions">
201
+ <li class="tsd-description">
202
+ <aside class="tsd-sources">
203
+ <ul>
204
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L2478">services.ts:2478</a></li>
205
+ </ul>
206
+ </aside>
207
+ <div class="tsd-comment tsd-typography">
208
+ <div class="lead">
209
+ <p>Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.</p>
210
+ </div>
211
+ </div>
212
+ <h4 class="tsd-parameters-title">Parameters</h4>
213
+ <ul class="tsd-parameters">
214
+ <li>
215
+ <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
216
+ </li>
217
+ </ul>
218
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
219
+ </li>
220
+ </ul>
221
+ </section>
222
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
223
+ <a name="stop" class="tsd-anchor"></a>
224
+ <h3>stop</h3>
225
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
226
+ <li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
227
+ </ul>
228
+ <ul class="tsd-descriptions">
229
+ <li class="tsd-description">
230
+ <aside class="tsd-sources">
231
+ <ul>
232
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L2489">services.ts:2489</a></li>
233
+ </ul>
234
+ </aside>
235
+ <div class="tsd-comment tsd-typography">
236
+ <div class="lead">
237
+ <p>Issues a command instructing the ngrok agent that started this tunnel session to exit.</p>
238
+ </div>
239
+ </div>
240
+ <h4 class="tsd-parameters-title">Parameters</h4>
241
+ <ul class="tsd-parameters">
242
+ <li>
243
+ <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
244
+ </li>
245
+ </ul>
246
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
247
+ </li>
248
+ </ul>
249
+ </section>
250
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
251
+ <a name="update" class="tsd-anchor"></a>
252
+ <h3>update</h3>
253
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
254
+ <li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.TunnelSessionsUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSessionsUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
255
+ </ul>
256
+ <ul class="tsd-descriptions">
257
+ <li class="tsd-description">
258
+ <aside class="tsd-sources">
259
+ <ul>
260
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L2500">services.ts:2500</a></li>
261
+ </ul>
262
+ </aside>
263
+ <div class="tsd-comment tsd-typography">
264
+ <div class="lead">
265
+ <p>Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent&#39;s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted</p>
266
+ </div>
267
+ </div>
268
+ <h4 class="tsd-parameters-title">Parameters</h4>
269
+ <ul class="tsd-parameters">
270
+ <li>
271
+ <h5>arg: <a href="../interfaces/datatypes.TunnelSessionsUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSessionsUpdate</a></h5>
272
+ </li>
273
+ </ul>
274
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
275
+ </li>
276
+ </ul>
277
+ </section>
278
+ </section>
279
+ </div>
280
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
281
+ <nav class="tsd-navigation primary">
282
+ <ul>
283
+ <li class=" ">
284
+ <a href="../modules.html">Modules</a>
285
+ </li>
286
+ <li class=" tsd-kind-module">
287
+ <a href="../modules/client.html">client</a>
288
+ </li>
289
+ <li class=" tsd-kind-module">
290
+ <a href="../modules/datatypes.html">datatypes</a>
291
+ </li>
292
+ <li class="current tsd-kind-module">
293
+ <a href="../modules/services.html">services</a>
294
+ </li>
295
+ </ul>
296
+ </nav>
297
+ <nav class="tsd-navigation secondary menu-sticky">
298
+ <ul class="before-current">
299
+ <li class=" tsd-kind-class tsd-parent-kind-module">
300
+ <a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
301
+ </li>
302
+ <li class=" tsd-kind-class tsd-parent-kind-module">
303
+ <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
304
+ </li>
305
+ <li class=" tsd-kind-class tsd-parent-kind-module">
306
+ <a href="services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
307
+ </li>
308
+ <li class=" tsd-kind-class tsd-parent-kind-module">
309
+ <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
310
+ </li>
311
+ <li class=" tsd-kind-class tsd-parent-kind-module">
312
+ <a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
313
+ </li>
314
+ <li class=" tsd-kind-class tsd-parent-kind-module">
315
+ <a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
316
+ </li>
317
+ <li class=" tsd-kind-class tsd-parent-kind-module">
318
+ <a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
319
+ </li>
320
+ <li class=" tsd-kind-class tsd-parent-kind-module">
321
+ <a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
322
+ </li>
323
+ <li class=" tsd-kind-class tsd-parent-kind-module">
324
+ <a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
325
+ </li>
326
+ <li class=" tsd-kind-class tsd-parent-kind-module">
327
+ <a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
328
+ </li>
329
+ <li class=" tsd-kind-class tsd-parent-kind-module">
330
+ <a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
331
+ </li>
332
+ <li class=" tsd-kind-class tsd-parent-kind-module">
333
+ <a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
334
+ </li>
335
+ <li class=" tsd-kind-class tsd-parent-kind-module">
336
+ <a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
337
+ </li>
338
+ <li class=" tsd-kind-class tsd-parent-kind-module">
339
+ <a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
340
+ </li>
341
+ <li class=" tsd-kind-class tsd-parent-kind-module">
342
+ <a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
343
+ </li>
344
+ <li class=" tsd-kind-class tsd-parent-kind-module">
345
+ <a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
346
+ </li>
347
+ <li class=" tsd-kind-class tsd-parent-kind-module">
348
+ <a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
349
+ </li>
350
+ <li class=" tsd-kind-class tsd-parent-kind-module">
351
+ <a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
352
+ </li>
353
+ <li class=" tsd-kind-class tsd-parent-kind-module">
354
+ <a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
355
+ </li>
356
+ <li class=" tsd-kind-class tsd-parent-kind-module">
357
+ <a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
358
+ </li>
359
+ <li class=" tsd-kind-class tsd-parent-kind-module">
360
+ <a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
361
+ </li>
362
+ <li class=" tsd-kind-class tsd-parent-kind-module">
363
+ <a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
364
+ </li>
365
+ <li class=" tsd-kind-class tsd-parent-kind-module">
366
+ <a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
367
+ </li>
368
+ <li class=" tsd-kind-class tsd-parent-kind-module">
369
+ <a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
370
+ </li>
371
+ <li class=" tsd-kind-class tsd-parent-kind-module">
372
+ <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
373
+ </li>
374
+ <li class=" tsd-kind-class tsd-parent-kind-module">
375
+ <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
376
+ </li>
377
+ <li class=" tsd-kind-class tsd-parent-kind-module">
378
+ <a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
379
+ </li>
380
+ <li class=" tsd-kind-class tsd-parent-kind-module">
381
+ <a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
382
+ </li>
383
+ <li class=" tsd-kind-class tsd-parent-kind-module">
384
+ <a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
385
+ </li>
386
+ <li class=" tsd-kind-class tsd-parent-kind-module">
387
+ <a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
388
+ </li>
389
+ <li class=" tsd-kind-class tsd-parent-kind-module">
390
+ <a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
391
+ </li>
392
+ <li class=" tsd-kind-class tsd-parent-kind-module">
393
+ <a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
394
+ </li>
395
+ </ul>
396
+ <ul class="current">
397
+ <li class="current tsd-kind-class tsd-parent-kind-module">
398
+ <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
399
+ <ul>
400
+ <li class=" tsd-kind-constructor tsd-parent-kind-class">
401
+ <a href="services.TunnelSessions.html#constructor" class="tsd-kind-icon">constructor</a>
402
+ </li>
403
+ <li class=" tsd-kind-method tsd-parent-kind-class">
404
+ <a href="services.TunnelSessions.html#get" class="tsd-kind-icon">get</a>
405
+ </li>
406
+ <li class=" tsd-kind-method tsd-parent-kind-class">
407
+ <a href="services.TunnelSessions.html#list" class="tsd-kind-icon">list</a>
408
+ </li>
409
+ <li class=" tsd-kind-method tsd-parent-kind-class">
410
+ <a href="services.TunnelSessions.html#restart" class="tsd-kind-icon">restart</a>
411
+ </li>
412
+ <li class=" tsd-kind-method tsd-parent-kind-class">
413
+ <a href="services.TunnelSessions.html#stop" class="tsd-kind-icon">stop</a>
414
+ </li>
415
+ <li class=" tsd-kind-method tsd-parent-kind-class">
416
+ <a href="services.TunnelSessions.html#update" class="tsd-kind-icon">update</a>
417
+ </li>
418
+ </ul>
419
+ </li>
420
+ </ul>
421
+ <ul class="after-current">
422
+ <li class=" tsd-kind-class tsd-parent-kind-module">
423
+ <a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
424
+ </li>
425
+ </ul>
426
+ </nav>
427
+ </div>
428
+ </div>
429
+ </div>
430
+ <footer class="with-border-bottom">
431
+ <div class="container">
432
+ <h2>Legend</h2>
433
+ <div class="tsd-legend-group">
434
+ <ul class="tsd-legend">
435
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
436
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
437
+ <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
438
+ </ul>
439
+ <ul class="tsd-legend">
440
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
441
+ </ul>
442
+ </div>
443
+ </div>
444
+ </footer>
445
+ <div class="container tsd-generator">
446
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
447
+ </div>
448
+ <div class="overlay"></div>
449
+ <script src="../assets/js/main.js"></script>
450
+ </body>
451
+ </html>