@ngrok/ngrok-api 0.10.0 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (275) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/docs/assets/js/search.js +1 -1
  3. package/docs/classes/client.Ngrok.html +55 -29
  4. package/docs/classes/services.APIKeys.html +6 -6
  5. package/docs/classes/services.AbuseReports.html +3 -3
  6. package/docs/classes/services.AgentIngresses.html +6 -6
  7. package/docs/classes/services.ApplicationSessions.html +4 -4
  8. package/docs/classes/services.ApplicationUsers.html +4 -4
  9. package/docs/classes/services.BotUsers.html +352 -0
  10. package/docs/classes/services.CertificateAuthorities.html +6 -6
  11. package/docs/classes/services.Credentials.html +6 -6
  12. package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
  13. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
  14. package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
  15. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
  16. package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
  17. package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
  18. package/docs/classes/services.EdgeRoutePolicyModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  20. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  21. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  22. package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +270 -0
  23. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  24. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  25. package/docs/classes/services.EdgesHTTPS.html +6 -6
  26. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  27. package/docs/classes/services.EdgesTCP.html +6 -6
  28. package/docs/classes/services.EdgesTLS.html +6 -6
  29. package/docs/classes/services.Endpoints.html +3 -3
  30. package/docs/classes/services.EventDestinations.html +6 -6
  31. package/docs/classes/services.EventSources.html +6 -6
  32. package/docs/classes/services.EventSubscriptions.html +6 -6
  33. package/docs/classes/services.FailoverBackends.html +6 -6
  34. package/docs/classes/services.HTTPResponseBackends.html +6 -6
  35. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
  36. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
  37. package/docs/classes/services.IPPolicies.html +6 -6
  38. package/docs/classes/services.IPPolicyRules.html +6 -6
  39. package/docs/classes/services.IPRestrictions.html +6 -6
  40. package/docs/classes/services.ReservedAddrs.html +6 -6
  41. package/docs/classes/services.ReservedDomains.html +8 -8
  42. package/docs/classes/services.SSHCertificateAuthorities.html +6 -6
  43. package/docs/classes/services.SSHCredentials.html +6 -6
  44. package/docs/classes/services.SSHHostCertificates.html +6 -6
  45. package/docs/classes/services.SSHUserCertificates.html +6 -6
  46. package/docs/classes/services.StaticBackends.html +360 -0
  47. package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
  48. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
  49. package/docs/classes/services.TCPEdgePolicyModule.html +270 -0
  50. package/docs/classes/services.TLSCertificates.html +6 -6
  51. package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
  52. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
  53. package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
  54. package/docs/classes/services.TLSEdgePolicyModule.html +270 -0
  55. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
  56. package/docs/classes/services.TunnelGroupBackends.html +6 -6
  57. package/docs/classes/services.TunnelSessions.html +6 -6
  58. package/docs/classes/services.Tunnels.html +3 -3
  59. package/docs/classes/services.WeightedBackends.html +6 -6
  60. package/docs/interfaces/client.NgrokConfig.html +3 -3
  61. package/docs/interfaces/datatypes.APIKey.html +7 -7
  62. package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
  63. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  64. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  65. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  66. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  67. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  68. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  69. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  70. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  71. package/docs/interfaces/datatypes.AgentIngress.html +10 -10
  72. package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
  73. package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
  74. package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
  75. package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
  76. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  77. package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
  78. package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
  79. package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
  80. package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
  81. package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
  82. package/docs/interfaces/datatypes.BotUser.html +243 -0
  83. package/docs/interfaces/datatypes.BotUserCreate.html +186 -0
  84. package/docs/interfaces/datatypes.BotUserList.html +205 -0
  85. package/docs/interfaces/datatypes.BotUserUpdate.html +200 -0
  86. package/docs/interfaces/datatypes.BrowserSession.html +3 -3
  87. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  88. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  89. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  90. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  91. package/docs/interfaces/datatypes.Credential.html +8 -8
  92. package/docs/interfaces/datatypes.CredentialCreate.html +4 -4
  93. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  94. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  95. package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
  96. package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
  97. package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
  98. package/docs/interfaces/datatypes.EdgePolicyReplace.html +176 -0
  99. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  100. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  101. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  102. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  103. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  104. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  105. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  106. package/docs/interfaces/datatypes.EdgeRoutePolicyReplace.html +190 -0
  107. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  108. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  109. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  110. package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +190 -0
  111. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  112. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  113. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  114. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  115. package/docs/interfaces/datatypes.Endpoint.html +13 -13
  116. package/docs/interfaces/datatypes.EndpointAction.html +186 -0
  117. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  118. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  119. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  120. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  121. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  122. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  123. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  124. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  125. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  126. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  127. package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +5 -5
  128. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  129. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  130. package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
  131. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  132. package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
  133. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  134. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
  135. package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
  136. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  137. package/docs/interfaces/datatypes.EndpointPolicy.html +205 -0
  138. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  139. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  140. package/docs/interfaces/datatypes.EndpointRule.html +205 -0
  141. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  142. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  143. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  144. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  145. package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +190 -0
  146. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  147. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
  148. package/docs/interfaces/datatypes.Error.html +4 -4
  149. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  150. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  151. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  152. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  153. package/docs/interfaces/datatypes.EventSource.html +2 -2
  154. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  155. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  156. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  157. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  158. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  159. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  160. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  161. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
  162. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  163. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  164. package/docs/interfaces/datatypes.EventTarget.html +4 -4
  165. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  166. package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
  167. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  168. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  169. package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
  170. package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
  171. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  172. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  173. package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
  174. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
  175. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
  176. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
  177. package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
  178. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
  179. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  180. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +52 -19
  181. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +49 -16
  182. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +50 -17
  183. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  184. package/docs/interfaces/datatypes.IPPolicy.html +5 -5
  185. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
  186. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  187. package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
  188. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
  189. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  190. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  191. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  192. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  193. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  194. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  195. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  196. package/docs/interfaces/datatypes.IdentityProvider.html +2 -2
  197. package/docs/interfaces/datatypes.Item.html +1 -1
  198. package/docs/interfaces/datatypes.Location.html +4 -4
  199. package/docs/interfaces/datatypes.Paging.html +2 -2
  200. package/docs/interfaces/datatypes.Ref.html +2 -2
  201. package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
  202. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
  203. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  204. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
  205. package/docs/interfaces/datatypes.ReservedDomain.html +14 -14
  206. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
  207. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  208. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  209. package/docs/interfaces/datatypes.ReservedDomainCreate.html +7 -7
  210. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  211. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
  212. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  213. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  214. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  215. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  216. package/docs/interfaces/datatypes.SSHCredential.html +8 -8
  217. package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
  218. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  219. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  220. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  221. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  222. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  223. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  224. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  225. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  226. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  227. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  228. package/docs/interfaces/datatypes.StaticBackend.html +281 -0
  229. package/docs/interfaces/datatypes.StaticBackendCreate.html +224 -0
  230. package/docs/interfaces/datatypes.StaticBackendList.html +205 -0
  231. package/docs/interfaces/datatypes.StaticBackendTLS.html +167 -0
  232. package/docs/interfaces/datatypes.StaticBackendUpdate.html +238 -0
  233. package/docs/interfaces/datatypes.TCPEdge.html +27 -8
  234. package/docs/interfaces/datatypes.TCPEdgeCreate.html +24 -5
  235. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  236. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +25 -6
  237. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  238. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  239. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  240. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  241. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  242. package/docs/interfaces/datatypes.TLSEdge.html +29 -10
  243. package/docs/interfaces/datatypes.TLSEdgeCreate.html +26 -7
  244. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  245. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +27 -8
  246. package/docs/interfaces/datatypes.Tunnel.html +11 -11
  247. package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
  248. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
  249. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  250. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  251. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  252. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  253. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  254. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  255. package/docs/interfaces/datatypes.UserAgent.html +6 -6
  256. package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
  257. package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
  258. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  259. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
  260. package/docs/modules/datatypes.html +64 -0
  261. package/docs/modules/services.html +24 -0
  262. package/lib/client.d.ts +8 -1
  263. package/lib/client.d.ts.map +1 -1
  264. package/lib/client.js +3 -0
  265. package/lib/client.js.map +1 -1
  266. package/lib/datatypes.d.ts +148 -4
  267. package/lib/datatypes.d.ts.map +1 -1
  268. package/lib/services.d.ts +90 -0
  269. package/lib/services.d.ts.map +1 -1
  270. package/lib/services.js +404 -85
  271. package/lib/services.js.map +1 -1
  272. package/package.json +2 -1
  273. package/src/client.ts +12 -1
  274. package/src/datatypes.ts +164 -4
  275. package/src/services.ts +334 -0
@@ -105,7 +105,7 @@
105
105
  <div class="tsd-signature tsd-kind-icon">critical<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
106
106
  <aside class="tsd-sources">
107
107
  <ul>
108
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1982">datatypes.ts:1982</a></li>
108
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2142">datatypes.ts:2142</a></li>
109
109
  </ul>
110
110
  </aside>
111
111
  <div class="tsd-comment tsd-typography">
@@ -120,7 +120,7 @@
120
120
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
121
121
  <aside class="tsd-sources">
122
122
  <ul>
123
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1990">datatypes.ts:1990</a></li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2150">datatypes.ts:2150</a></li>
124
124
  </ul>
125
125
  </aside>
126
126
  <div class="tsd-comment tsd-typography">
@@ -135,7 +135,7 @@
135
135
  <div class="tsd-signature tsd-kind-icon">extensions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
136
136
  <aside class="tsd-sources">
137
137
  <ul>
138
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1984">datatypes.ts:1984</a></li>
138
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2144">datatypes.ts:2144</a></li>
139
139
  </ul>
140
140
  </aside>
141
141
  <div class="tsd-comment tsd-typography">
@@ -150,7 +150,7 @@
150
150
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
151
151
  <aside class="tsd-sources">
152
152
  <ul>
153
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1992">datatypes.ts:1992</a></li>
153
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2152">datatypes.ts:2152</a></li>
154
154
  </ul>
155
155
  </aside>
156
156
  <div class="tsd-comment tsd-typography">
@@ -165,7 +165,7 @@
165
165
  <div class="tsd-signature tsd-kind-icon">principals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
166
166
  <aside class="tsd-sources">
167
167
  <ul>
168
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1980">datatypes.ts:1980</a></li>
168
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2140">datatypes.ts:2140</a></li>
169
169
  </ul>
170
170
  </aside>
171
171
  <div class="tsd-comment tsd-typography">
@@ -180,7 +180,7 @@
180
180
  <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
181
181
  <aside class="tsd-sources">
182
182
  <ul>
183
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1978">datatypes.ts:1978</a></li>
183
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2138">datatypes.ts:2138</a></li>
184
184
  </ul>
185
185
  </aside>
186
186
  <div class="tsd-comment tsd-typography">
@@ -195,7 +195,7 @@
195
195
  <div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
196
196
  <aside class="tsd-sources">
197
197
  <ul>
198
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1976">datatypes.ts:1976</a></li>
198
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2136">datatypes.ts:2136</a></li>
199
199
  </ul>
200
200
  </aside>
201
201
  <div class="tsd-comment tsd-typography">
@@ -210,7 +210,7 @@
210
210
  <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
211
211
  <aside class="tsd-sources">
212
212
  <ul>
213
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1986">datatypes.ts:1986</a></li>
213
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2146">datatypes.ts:2146</a></li>
214
214
  </ul>
215
215
  </aside>
216
216
  <div class="tsd-comment tsd-typography">
@@ -225,7 +225,7 @@
225
225
  <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
226
226
  <aside class="tsd-sources">
227
227
  <ul>
228
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1988">datatypes.ts:1988</a></li>
228
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2148">datatypes.ts:2148</a></li>
229
229
  </ul>
230
230
  </aside>
231
231
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2040">datatypes.ts:2040</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2200">datatypes.ts:2200</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">ssh<wbr>User<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="datatypes.SSHUserCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHUserCertificate</a><span class="tsd-signature-symbol">[]</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2036">datatypes.ts:2036</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2196">datatypes.ts:2196</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/9fd8564/src/datatypes.ts#L2038">datatypes.ts:2038</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2198">datatypes.ts:2198</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1998">datatypes.ts:1998</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2158">datatypes.ts:2158</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1996">datatypes.ts:1996</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2156">datatypes.ts:2156</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  </section>
@@ -124,7 +124,7 @@
124
124
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125
125
  <aside class="tsd-sources">
126
126
  <ul>
127
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2000">datatypes.ts:2000</a></li>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2160">datatypes.ts:2160</a></li>
128
128
  </ul>
129
129
  </aside>
130
130
  <div class="tsd-comment tsd-typography">
@@ -0,0 +1,281 @@
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>StaticBackend | @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.StaticBackend.html">StaticBackend</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface StaticBackend</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">StaticBackend</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.StaticBackend.html#address" class="tsd-kind-icon">address</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.StaticBackend.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.StaticBackend.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.StaticBackend.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.StaticBackend.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.StaticBackend.html#tls" class="tsd-kind-icon">tls</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.StaticBackend.html#uri" class="tsd-kind-icon">uri</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="address" class="tsd-anchor"></a>
102
+ <h3>address</h3>
103
+ <div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104
+ <aside class="tsd-sources">
105
+ <ul>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L431">datatypes.ts:431</a></li>
107
+ </ul>
108
+ </aside>
109
+ <div class="tsd-comment tsd-typography">
110
+ <div class="lead">
111
+ <p>the address to forward to</p>
112
+ </div>
113
+ </div>
114
+ </section>
115
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
116
+ <a name="createdAt" class="tsd-anchor"></a>
117
+ <h3>created<wbr>At</h3>
118
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
119
+ <aside class="tsd-sources">
120
+ <ul>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L425">datatypes.ts:425</a></li>
122
+ </ul>
123
+ </aside>
124
+ <div class="tsd-comment tsd-typography">
125
+ <div class="lead">
126
+ <p>timestamp when the backend was created, RFC 3339 format</p>
127
+ </div>
128
+ </div>
129
+ </section>
130
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
131
+ <a name="description" class="tsd-anchor"></a>
132
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
133
+ <div class="tsd-signature tsd-kind-icon">description<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/4214cc1/src/datatypes.ts#L427">datatypes.ts:427</a></li>
137
+ </ul>
138
+ </aside>
139
+ <div class="tsd-comment tsd-typography">
140
+ <div class="lead">
141
+ <p>human-readable description of this backend. Optional</p>
142
+ </div>
143
+ </div>
144
+ </section>
145
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
146
+ <a name="id" class="tsd-anchor"></a>
147
+ <h3>id</h3>
148
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149
+ <aside class="tsd-sources">
150
+ <ul>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L421">datatypes.ts:421</a></li>
152
+ </ul>
153
+ </aside>
154
+ <div class="tsd-comment tsd-typography">
155
+ <div class="lead">
156
+ <p>unique identifier for this static backend</p>
157
+ </div>
158
+ </div>
159
+ </section>
160
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
161
+ <a name="metadata" class="tsd-anchor"></a>
162
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
163
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
164
+ <aside class="tsd-sources">
165
+ <ul>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L429">datatypes.ts:429</a></li>
167
+ </ul>
168
+ </aside>
169
+ <div class="tsd-comment tsd-typography">
170
+ <div class="lead">
171
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
172
+ </div>
173
+ </div>
174
+ </section>
175
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
176
+ <a name="tls" class="tsd-anchor"></a>
177
+ <h3>tls</h3>
178
+ <div class="tsd-signature tsd-kind-icon">tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.StaticBackendTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackendTLS</a></div>
179
+ <aside class="tsd-sources">
180
+ <ul>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L433">datatypes.ts:433</a></li>
182
+ </ul>
183
+ </aside>
184
+ <div class="tsd-comment tsd-typography">
185
+ <div class="lead">
186
+ <p>tls configuration to use</p>
187
+ </div>
188
+ </div>
189
+ </section>
190
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
191
+ <a name="uri" class="tsd-anchor"></a>
192
+ <h3>uri</h3>
193
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
194
+ <aside class="tsd-sources">
195
+ <ul>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L423">datatypes.ts:423</a></li>
197
+ </ul>
198
+ </aside>
199
+ <div class="tsd-comment tsd-typography">
200
+ <div class="lead">
201
+ <p>URI of the StaticBackend API resource</p>
202
+ </div>
203
+ </div>
204
+ </section>
205
+ </section>
206
+ </div>
207
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
208
+ <nav class="tsd-navigation primary">
209
+ <ul>
210
+ <li class=" ">
211
+ <a href="../modules.html">Modules</a>
212
+ </li>
213
+ <li class=" tsd-kind-module">
214
+ <a href="../modules/client.html">client</a>
215
+ </li>
216
+ <li class="current tsd-kind-module">
217
+ <a href="../modules/datatypes.html">datatypes</a>
218
+ </li>
219
+ <li class=" tsd-kind-module">
220
+ <a href="../modules/services.html">services</a>
221
+ </li>
222
+ </ul>
223
+ </nav>
224
+ <nav class="tsd-navigation secondary menu-sticky">
225
+ <ul class="before-current">
226
+ </ul>
227
+ <ul class="current">
228
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
229
+ <a href="datatypes.StaticBackend.html" class="tsd-kind-icon">Static<wbr>Backend</a>
230
+ <ul>
231
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
232
+ <a href="datatypes.StaticBackend.html#address" class="tsd-kind-icon">address</a>
233
+ </li>
234
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
235
+ <a href="datatypes.StaticBackend.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
236
+ </li>
237
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
238
+ <a href="datatypes.StaticBackend.html#description" class="tsd-kind-icon">description</a>
239
+ </li>
240
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
241
+ <a href="datatypes.StaticBackend.html#id" class="tsd-kind-icon">id</a>
242
+ </li>
243
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
244
+ <a href="datatypes.StaticBackend.html#metadata" class="tsd-kind-icon">metadata</a>
245
+ </li>
246
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
247
+ <a href="datatypes.StaticBackend.html#tls" class="tsd-kind-icon">tls</a>
248
+ </li>
249
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
250
+ <a href="datatypes.StaticBackend.html#uri" class="tsd-kind-icon">uri</a>
251
+ </li>
252
+ </ul>
253
+ </li>
254
+ </ul>
255
+ <ul class="after-current">
256
+ </ul>
257
+ </nav>
258
+ </div>
259
+ </div>
260
+ </div>
261
+ <footer class="with-border-bottom">
262
+ <div class="container">
263
+ <h2>Legend</h2>
264
+ <div class="tsd-legend-group">
265
+ <ul class="tsd-legend">
266
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
267
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
268
+ </ul>
269
+ <ul class="tsd-legend">
270
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
271
+ </ul>
272
+ </div>
273
+ </div>
274
+ </footer>
275
+ <div class="container tsd-generator">
276
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
277
+ </div>
278
+ <div class="overlay"></div>
279
+ <script src="../assets/js/main.js"></script>
280
+ </body>
281
+ </html>
@@ -0,0 +1,224 @@
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>StaticBackendCreate | @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.StaticBackendCreate.html">StaticBackendCreate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface StaticBackendCreate</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">StaticBackendCreate</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.StaticBackendCreate.html#address" class="tsd-kind-icon">address</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.StaticBackendCreate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.StaticBackendCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.StaticBackendCreate.html#tls" class="tsd-kind-icon">tls</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="address" class="tsd-anchor"></a>
99
+ <h3>address</h3>
100
+ <div class="tsd-signature tsd-kind-icon">address<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/4214cc1/src/datatypes.ts#L447">datatypes.ts:447</a></li>
104
+ </ul>
105
+ </aside>
106
+ <div class="tsd-comment tsd-typography">
107
+ <div class="lead">
108
+ <p>the address to forward to</p>
109
+ </div>
110
+ </div>
111
+ </section>
112
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
+ <a name="description" class="tsd-anchor"></a>
114
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
115
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
+ <aside class="tsd-sources">
117
+ <ul>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L443">datatypes.ts:443</a></li>
119
+ </ul>
120
+ </aside>
121
+ <div class="tsd-comment tsd-typography">
122
+ <div class="lead">
123
+ <p>human-readable description of this backend. Optional</p>
124
+ </div>
125
+ </div>
126
+ </section>
127
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
128
+ <a name="metadata" class="tsd-anchor"></a>
129
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
130
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
+ <aside class="tsd-sources">
132
+ <ul>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L445">datatypes.ts:445</a></li>
134
+ </ul>
135
+ </aside>
136
+ <div class="tsd-comment tsd-typography">
137
+ <div class="lead">
138
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
139
+ </div>
140
+ </div>
141
+ </section>
142
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
143
+ <a name="tls" class="tsd-anchor"></a>
144
+ <h3>tls</h3>
145
+ <div class="tsd-signature tsd-kind-icon">tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.StaticBackendTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackendTLS</a></div>
146
+ <aside class="tsd-sources">
147
+ <ul>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L449">datatypes.ts:449</a></li>
149
+ </ul>
150
+ </aside>
151
+ <div class="tsd-comment tsd-typography">
152
+ <div class="lead">
153
+ <p>tls configuration to use</p>
154
+ </div>
155
+ </div>
156
+ </section>
157
+ </section>
158
+ </div>
159
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
160
+ <nav class="tsd-navigation primary">
161
+ <ul>
162
+ <li class=" ">
163
+ <a href="../modules.html">Modules</a>
164
+ </li>
165
+ <li class=" tsd-kind-module">
166
+ <a href="../modules/client.html">client</a>
167
+ </li>
168
+ <li class="current tsd-kind-module">
169
+ <a href="../modules/datatypes.html">datatypes</a>
170
+ </li>
171
+ <li class=" tsd-kind-module">
172
+ <a href="../modules/services.html">services</a>
173
+ </li>
174
+ </ul>
175
+ </nav>
176
+ <nav class="tsd-navigation secondary menu-sticky">
177
+ <ul class="before-current">
178
+ </ul>
179
+ <ul class="current">
180
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
181
+ <a href="datatypes.StaticBackendCreate.html" class="tsd-kind-icon">Static<wbr>Backend<wbr>Create</a>
182
+ <ul>
183
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
184
+ <a href="datatypes.StaticBackendCreate.html#address" class="tsd-kind-icon">address</a>
185
+ </li>
186
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
187
+ <a href="datatypes.StaticBackendCreate.html#description" class="tsd-kind-icon">description</a>
188
+ </li>
189
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
190
+ <a href="datatypes.StaticBackendCreate.html#metadata" class="tsd-kind-icon">metadata</a>
191
+ </li>
192
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
193
+ <a href="datatypes.StaticBackendCreate.html#tls" class="tsd-kind-icon">tls</a>
194
+ </li>
195
+ </ul>
196
+ </li>
197
+ </ul>
198
+ <ul class="after-current">
199
+ </ul>
200
+ </nav>
201
+ </div>
202
+ </div>
203
+ </div>
204
+ <footer class="with-border-bottom">
205
+ <div class="container">
206
+ <h2>Legend</h2>
207
+ <div class="tsd-legend-group">
208
+ <ul class="tsd-legend">
209
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
210
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
211
+ </ul>
212
+ <ul class="tsd-legend">
213
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
214
+ </ul>
215
+ </div>
216
+ </div>
217
+ </footer>
218
+ <div class="container tsd-generator">
219
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
220
+ </div>
221
+ <div class="overlay"></div>
222
+ <script src="../assets/js/main.js"></script>
223
+ </body>
224
+ </html>