@ngrok/ngrok-api 0.1.0 → 0.7.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 (283) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +102 -31
  3. package/docs/CNAME +1 -0
  4. package/docs/assets/js/search.js +1 -1
  5. package/docs/classes/client.Ngrok.html +772 -0
  6. package/docs/classes/services.APIKeys.html +354 -0
  7. package/docs/classes/services.AbuseReports.html +261 -0
  8. package/docs/classes/services.AgentIngresses.html +343 -0
  9. package/docs/classes/services.CertificateAuthorities.html +354 -0
  10. package/docs/classes/services.Credentials.html +353 -0
  11. package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
  12. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
  13. package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
  14. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +270 -0
  15. package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
  16. package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
  17. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +270 -0
  18. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
  20. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
  21. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
  22. package/docs/classes/services.EdgesHTTPS.html +343 -0
  23. package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
  24. package/docs/classes/services.EdgesTCP.html +343 -0
  25. package/docs/classes/services.EdgesTLS.html +343 -0
  26. package/docs/classes/services.Endpoints.html +256 -0
  27. package/docs/classes/services.EventDestinations.html +343 -0
  28. package/docs/classes/services.EventSources.html +349 -0
  29. package/docs/classes/services.EventSubscriptions.html +343 -0
  30. package/docs/classes/services.FailoverBackends.html +353 -0
  31. package/docs/classes/services.HTTPResponseBackends.html +318 -0
  32. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +270 -0
  33. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +270 -0
  34. package/docs/classes/services.IPPolicies.html +353 -0
  35. package/docs/classes/services.IPPolicyRules.html +351 -0
  36. package/docs/classes/services.IPRestrictions.html +355 -0
  37. package/docs/classes/services.ReservedAddrs.html +352 -0
  38. package/docs/classes/services.ReservedDomains.html +417 -0
  39. package/docs/classes/services.SSHCertificateAuthorities.html +351 -0
  40. package/docs/classes/services.SSHCredentials.html +351 -0
  41. package/docs/classes/services.SSHHostCertificates.html +352 -0
  42. package/docs/classes/services.SSHUserCertificates.html +352 -0
  43. package/docs/classes/services.TCPEdgeBackendModule.html +270 -0
  44. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +270 -0
  45. package/docs/classes/services.TLSCertificates.html +354 -0
  46. package/docs/classes/services.TLSEdgeBackendModule.html +270 -0
  47. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +270 -0
  48. package/docs/classes/services.TLSEdgeMutualTLSModule.html +270 -0
  49. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
  50. package/docs/classes/services.TunnelGroupBackends.html +351 -0
  51. package/docs/classes/services.TunnelSessions.html +352 -0
  52. package/docs/classes/services.Tunnels.html +255 -0
  53. package/docs/classes/services.WeightedBackends.html +353 -0
  54. package/docs/index.html +103 -546
  55. package/docs/interfaces/client.NgrokConfig.html +179 -0
  56. package/docs/interfaces/{apikey.html → datatypes.APIKey.html} +41 -29
  57. package/docs/interfaces/{apikeycreate.html → datatypes.APIKeyCreate.html} +25 -13
  58. package/docs/interfaces/{apikeylist.html → datatypes.APIKeyList.html} +32 -20
  59. package/docs/interfaces/{apikeyupdate.html → datatypes.APIKeyUpdate.html} +28 -16
  60. package/docs/interfaces/{awsauth.html → datatypes.AWSAuth.html} +27 -15
  61. package/docs/interfaces/{awscredentials.html → datatypes.AWSCredentials.html} +31 -19
  62. package/docs/interfaces/{awsrole.html → datatypes.AWSRole.html} +25 -13
  63. package/docs/interfaces/{abusereport.html → datatypes.AbuseReport.html} +45 -33
  64. package/docs/interfaces/{abusereportcreate.html → datatypes.AbuseReportCreate.html} +25 -13
  65. package/docs/interfaces/{abusereporthostname.html → datatypes.AbuseReportHostname.html} +26 -14
  66. package/docs/interfaces/datatypes.AgentIngress.html +300 -0
  67. package/docs/interfaces/{ipwhitelistentrycreate.html → datatypes.AgentIngressCreate.html} +37 -25
  68. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  69. package/docs/interfaces/{ipwhitelistentryupdate.html → datatypes.AgentIngressUpdate.html} +33 -21
  70. package/docs/interfaces/{certificateauthority.html → datatypes.CertificateAuthority.html} +73 -61
  71. package/docs/interfaces/{certificateauthoritycreate.html → datatypes.CertificateAuthorityCreate.html} +31 -19
  72. package/docs/interfaces/{certificateauthoritylist.html → datatypes.CertificateAuthorityList.html} +34 -22
  73. package/docs/interfaces/{certificateauthorityupdate.html → datatypes.CertificateAuthorityUpdate.html} +28 -16
  74. package/docs/interfaces/{credential.html → datatypes.Credential.html} +45 -33
  75. package/docs/interfaces/{credentialcreate.html → datatypes.CredentialCreate.html} +29 -17
  76. package/docs/interfaces/{credentiallist.html → datatypes.CredentialList.html} +32 -20
  77. package/docs/interfaces/{credentialupdate.html → datatypes.CredentialUpdate.html} +32 -20
  78. package/docs/interfaces/{endpointippolicyreplace.html → datatypes.EdgeBackendReplace.html} +29 -17
  79. package/docs/interfaces/{endpointbackendreplace.html → datatypes.EdgeIPRestrictionReplace.html} +29 -17
  80. package/docs/interfaces/{endpointresponseheadersreplace.html → datatypes.EdgeMutualTLSReplace.html} +29 -17
  81. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
  82. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
  83. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +190 -0
  84. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
  85. package/docs/interfaces/{reserveddomaincertnstarget.html → datatypes.EdgeRouteItem.html} +36 -24
  86. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +190 -0
  87. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
  88. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +190 -0
  89. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
  90. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +190 -0
  91. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +190 -0
  92. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
  93. package/docs/interfaces/{endpointoauthreplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +29 -17
  94. package/docs/interfaces/{endpointbasicauthreplace.html → datatypes.EdgeTLSTerminationReplace.html} +29 -17
  95. package/docs/interfaces/{empty.html → datatypes.Empty.html} +18 -7
  96. package/docs/interfaces/datatypes.Endpoint.html +395 -0
  97. package/docs/interfaces/{endpointbackend.html → datatypes.EndpointBackend.html} +27 -15
  98. package/docs/interfaces/{endpointlogging.html → datatypes.EndpointBackendMutate.html} +36 -24
  99. package/docs/interfaces/{endpointcircuitbreaker.html → datatypes.EndpointCircuitBreaker.html} +53 -41
  100. package/docs/interfaces/{endpointcompression.html → datatypes.EndpointCompression.html} +23 -11
  101. package/docs/interfaces/{endpointippolicy.html → datatypes.EndpointIPPolicy.html} +29 -17
  102. package/docs/interfaces/{endpointippolicymutate.html → datatypes.EndpointIPPolicyMutate.html} +29 -17
  103. package/docs/interfaces/datatypes.EndpointList.html +205 -0
  104. package/docs/interfaces/{endpointmutualtls.html → datatypes.EndpointMutualTLS.html} +29 -17
  105. package/docs/interfaces/{endpointmutualtlsmutate.html → datatypes.EndpointMutualTLSMutate.html} +29 -17
  106. package/docs/interfaces/{endpointoauth.html → datatypes.EndpointOAuth.html} +57 -45
  107. package/docs/interfaces/{endpointoauthfacebook.html → datatypes.EndpointOAuthFacebook.html} +48 -36
  108. package/docs/interfaces/{endpointoauthgithub.html → datatypes.EndpointOAuthGitHub.html} +55 -43
  109. package/docs/interfaces/{endpointoauthgoogle.html → datatypes.EndpointOAuthGoogle.html} +48 -36
  110. package/docs/interfaces/{endpointoauthmicrosoft.html → datatypes.EndpointOAuthMicrosoft.html} +48 -36
  111. package/docs/interfaces/{endpointoauthprovider.html → datatypes.EndpointOAuthProvider.html} +35 -23
  112. package/docs/interfaces/{endpointoidc.html → datatypes.EndpointOIDC.html} +65 -53
  113. package/docs/interfaces/{endpointrequestheaders.html → datatypes.EndpointRequestHeaders.html} +29 -17
  114. package/docs/interfaces/{endpointresponseheaders.html → datatypes.EndpointResponseHeaders.html} +29 -17
  115. package/docs/interfaces/{endpointsaml.html → datatypes.EndpointSAML.html} +121 -90
  116. package/docs/interfaces/{endpointsamlmutate.html → datatypes.EndpointSAMLMutate.html} +91 -60
  117. package/docs/interfaces/{endpointtlstermination.html → datatypes.EndpointTLSTermination.html} +37 -25
  118. package/docs/interfaces/{endpointloggingmutate.html → datatypes.EndpointTLSTerminationAtEdge.html} +33 -21
  119. package/docs/interfaces/{endpointwebhookvalidation.html → datatypes.EndpointWebhookValidation.html} +30 -18
  120. package/docs/interfaces/{staticbackendtls.html → datatypes.EndpointWebsocketTCPConverter.html} +27 -15
  121. package/docs/interfaces/{error.html → datatypes.Error.html} +37 -25
  122. package/docs/interfaces/{eventdestination.html → datatypes.EventDestination.html} +46 -34
  123. package/docs/interfaces/{eventdestinationcreate.html → datatypes.EventDestinationCreate.html} +34 -22
  124. package/docs/interfaces/{eventdestinationlist.html → datatypes.EventDestinationList.html} +34 -22
  125. package/docs/interfaces/{eventdestinationupdate.html → datatypes.EventDestinationUpdate.html} +37 -25
  126. package/docs/interfaces/{eventsource.html → datatypes.EventSource.html} +25 -13
  127. package/docs/interfaces/{eventsourcecreate.html → datatypes.EventSourceCreate.html} +28 -16
  128. package/docs/interfaces/{eventsourceitem.html → datatypes.EventSourceItem.html} +28 -16
  129. package/docs/interfaces/{eventsourcelist.html → datatypes.EventSourceList.html} +26 -14
  130. package/docs/interfaces/{eventsourcepaging.html → datatypes.EventSourcePaging.html} +25 -13
  131. package/docs/interfaces/{eventsourcereplace.html → datatypes.EventSourceReplace.html} +22 -10
  132. package/docs/interfaces/{eventsourceupdate.html → datatypes.EventSourceUpdate.html} +28 -16
  133. package/docs/interfaces/{eventsubscription.html → datatypes.EventSubscription.html} +45 -33
  134. package/docs/interfaces/{eventsubscriptioncreate.html → datatypes.EventSubscriptionCreate.html} +36 -24
  135. package/docs/interfaces/{eventsubscriptionlist.html → datatypes.EventSubscriptionList.html} +34 -22
  136. package/docs/interfaces/{eventsubscriptionupdate.html → datatypes.EventSubscriptionUpdate.html} +39 -27
  137. package/docs/interfaces/{eventtarget.html → datatypes.EventTarget.html} +33 -21
  138. package/docs/interfaces/{eventtargetcloudwatchlogs.html → datatypes.EventTargetCloudwatchLogs.html} +30 -18
  139. package/docs/interfaces/{eventtargetfirehose.html → datatypes.EventTargetFirehose.html} +30 -18
  140. package/docs/interfaces/{eventtargetkinesis.html → datatypes.EventTargetKinesis.html} +30 -18
  141. package/docs/interfaces/{staticbackend.html → datatypes.FailoverBackend.html} +52 -40
  142. package/docs/interfaces/{prioritybackendcreate.html → datatypes.FailoverBackendCreate.html} +31 -19
  143. package/docs/interfaces/{prioritybackendlist.html → datatypes.FailoverBackendList.html} +37 -25
  144. package/docs/interfaces/{prioritybackendupdate.html → datatypes.FailoverBackendUpdate.html} +34 -22
  145. package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
  146. package/docs/interfaces/{tunnelgroupbackend.html → datatypes.HTTPResponseBackendCreate.html} +53 -41
  147. package/docs/interfaces/{staticbackendlist.html → datatypes.HTTPResponseBackendList.html} +35 -38
  148. package/docs/interfaces/{tcpedge.html → datatypes.HTTPResponseBackendUpdate.html} +58 -65
  149. package/docs/interfaces/{eventstream.html → datatypes.HTTPSEdge.html} +78 -71
  150. package/docs/interfaces/{staticbackendupdate.html → datatypes.HTTPSEdgeCreate.html} +60 -48
  151. package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
  152. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +509 -0
  153. package/docs/interfaces/{endpointconfigurationcreate.html → datatypes.HTTPSEdgeRouteCreate.html} +141 -110
  154. package/docs/interfaces/{endpointconfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +138 -145
  155. package/docs/interfaces/{tlsedgeupdate.html → datatypes.HTTPSEdgeUpdate.html} +65 -43
  156. package/docs/interfaces/{ippolicy.html → datatypes.IPPolicy.html} +37 -44
  157. package/docs/interfaces/{ippolicycreate.html → datatypes.IPPolicyCreate.html} +25 -32
  158. package/docs/interfaces/{ippolicylist.html → datatypes.IPPolicyList.html} +34 -22
  159. package/docs/interfaces/{ippolicyrule.html → datatypes.IPPolicyRule.html} +65 -34
  160. package/docs/interfaces/{ippolicyrulecreate.html → datatypes.IPPolicyRuleCreate.html} +53 -22
  161. package/docs/interfaces/{ippolicyrulelist.html → datatypes.IPPolicyRuleList.html} +34 -22
  162. package/docs/interfaces/{ippolicyruleupdate.html → datatypes.IPPolicyRuleUpdate.html} +31 -19
  163. package/docs/interfaces/{ippolicyupdate.html → datatypes.IPPolicyUpdate.html} +28 -16
  164. package/docs/interfaces/{iprestriction.html → datatypes.IPRestriction.html} +50 -38
  165. package/docs/interfaces/{iprestrictioncreate.html → datatypes.IPRestrictionCreate.html} +38 -26
  166. package/docs/interfaces/{iprestrictionlist.html → datatypes.IPRestrictionList.html} +34 -22
  167. package/docs/interfaces/{iprestrictionupdate.html → datatypes.IPRestrictionUpdate.html} +37 -25
  168. package/docs/interfaces/{item.html → datatypes.Item.html} +22 -10
  169. package/docs/interfaces/{paging.html → datatypes.Paging.html} +28 -16
  170. package/docs/interfaces/{ref.html → datatypes.Ref.html} +25 -13
  171. package/docs/interfaces/{reservedaddr.html → datatypes.ReservedAddr.html} +43 -50
  172. package/docs/interfaces/{reservedaddrcreate.html → datatypes.ReservedAddrCreate.html} +28 -35
  173. package/docs/interfaces/{reservedaddrlist.html → datatypes.ReservedAddrList.html} +34 -22
  174. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +200 -0
  175. package/docs/interfaces/{reserveddomain.html → datatypes.ReservedDomain.html} +82 -89
  176. package/docs/interfaces/{reserveddomaincertjob.html → datatypes.ReservedDomainCertJob.html} +40 -47
  177. package/docs/interfaces/{reserveddomaincertpolicy.html → datatypes.ReservedDomainCertPolicy.html} +28 -16
  178. package/docs/interfaces/{reserveddomaincertstatus.html → datatypes.ReservedDomainCertStatus.html} +31 -19
  179. package/docs/interfaces/{reserveddomaincreate.html → datatypes.ReservedDomainCreate.html} +45 -71
  180. package/docs/interfaces/{reserveddomainlist.html → datatypes.ReservedDomainList.html} +34 -22
  181. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +238 -0
  182. package/docs/interfaces/{sshcertificateauthority.html → datatypes.SSHCertificateAuthority.html} +49 -37
  183. package/docs/interfaces/{sshcertificateauthoritycreate.html → datatypes.SSHCertificateAuthorityCreate.html} +45 -33
  184. package/docs/interfaces/{sshcertificateauthoritylist.html → datatypes.SSHCertificateAuthorityList.html} +34 -22
  185. package/docs/interfaces/{sshcertificateauthorityupdate.html → datatypes.SSHCertificateAuthorityUpdate.html} +28 -16
  186. package/docs/interfaces/{sshcredential.html → datatypes.SSHCredential.html} +47 -35
  187. package/docs/interfaces/{sshcredentialcreate.html → datatypes.SSHCredentialCreate.html} +35 -23
  188. package/docs/interfaces/{sshcredentiallist.html → datatypes.SSHCredentialList.html} +34 -22
  189. package/docs/interfaces/{sshcredentialupdate.html → datatypes.SSHCredentialUpdate.html} +32 -20
  190. package/docs/interfaces/{sshhostcertificate.html → datatypes.SSHHostCertificate.html} +76 -64
  191. package/docs/interfaces/{sshhostcertificatecreate.html → datatypes.SSHHostCertificateCreate.html} +53 -41
  192. package/docs/interfaces/{sshhostcertificatelist.html → datatypes.SSHHostCertificateList.html} +34 -22
  193. package/docs/interfaces/{sshhostcertificateupdate.html → datatypes.SSHHostCertificateUpdate.html} +28 -16
  194. package/docs/interfaces/{sshusercertificate.html → datatypes.SSHUserCertificate.html} +87 -75
  195. package/docs/interfaces/{sshusercertificatecreate.html → datatypes.SSHUserCertificateCreate.html} +64 -52
  196. package/docs/interfaces/{sshusercertificatelist.html → datatypes.SSHUserCertificateList.html} +34 -22
  197. package/docs/interfaces/{sshusercertificateupdate.html → datatypes.SSHUserCertificateUpdate.html} +28 -16
  198. package/docs/interfaces/{tlsedge.html → datatypes.TCPEdge.html} +69 -66
  199. package/docs/interfaces/{tlsedgecreate.html → datatypes.TCPEdgeCreate.html} +64 -42
  200. package/docs/interfaces/{endpointconfigurationlist.html → datatypes.TCPEdgeList.html} +40 -28
  201. package/docs/interfaces/{eventstreamupdate.html → datatypes.TCPEdgeUpdate.html} +60 -53
  202. package/docs/interfaces/{tlscertificate.html → datatypes.TLSCertificate.html} +134 -122
  203. package/docs/interfaces/{tlscertificatecreate.html → datatypes.TLSCertificateCreate.html} +39 -27
  204. package/docs/interfaces/{tlscertificatelist.html → datatypes.TLSCertificateList.html} +34 -22
  205. package/docs/interfaces/{tlscertificatesans.html → datatypes.TLSCertificateSANs.html} +28 -16
  206. package/docs/interfaces/{tlscertificateupdate.html → datatypes.TLSCertificateUpdate.html} +28 -16
  207. package/docs/interfaces/datatypes.TLSEdge.html +323 -0
  208. package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
  209. package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
  210. package/docs/interfaces/{reserveddomainupdate.html → datatypes.TLSEdgeUpdate.html} +83 -62
  211. package/docs/interfaces/datatypes.Tunnel.html +357 -0
  212. package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
  213. package/docs/interfaces/{tunnelgroupbackendcreate.html → datatypes.TunnelGroupBackendCreate.html} +28 -16
  214. package/docs/interfaces/{tunnelgroupbackendlist.html → datatypes.TunnelGroupBackendList.html} +32 -20
  215. package/docs/interfaces/{tunnelgroupbackendupdate.html → datatypes.TunnelGroupBackendUpdate.html} +31 -19
  216. package/docs/interfaces/{tunnellist.html → datatypes.TunnelList.html} +32 -20
  217. package/docs/interfaces/{tunnelsession.html → datatypes.TunnelSession.html} +57 -45
  218. package/docs/interfaces/{tunnelsessionlist.html → datatypes.TunnelSessionList.html} +34 -22
  219. package/docs/interfaces/{tunnelsessionsupdate.html → datatypes.TunnelSessionsUpdate.html} +22 -10
  220. package/docs/interfaces/{weightedbackend.html → datatypes.WeightedBackend.html} +56 -25
  221. package/docs/interfaces/{weightedbackendcreate.html → datatypes.WeightedBackendCreate.html} +28 -16
  222. package/docs/interfaces/{weightedbackendlist.html → datatypes.WeightedBackendList.html} +32 -20
  223. package/docs/interfaces/{weightedbackendupdate.html → datatypes.WeightedBackendUpdate.html} +31 -19
  224. package/docs/{interfaces/endpointbasicauth.html → modules/client.html} +38 -20
  225. package/docs/modules/datatypes.html +796 -0
  226. package/docs/modules/services.html +316 -0
  227. package/docs/modules.html +16 -690
  228. package/lib/client.d.ts +179 -0
  229. package/lib/client.d.ts.map +1 -0
  230. package/lib/client.js +126 -0
  231. package/lib/client.js.map +1 -0
  232. package/lib/{types.d.ts → datatypes.d.ts} +729 -660
  233. package/lib/datatypes.d.ts.map +1 -0
  234. package/lib/{types.js → datatypes.js} +1 -1
  235. package/lib/datatypes.js.map +1 -0
  236. package/lib/index.d.ts +2 -378
  237. package/lib/index.d.ts.map +1 -1
  238. package/lib/index.js +2 -2148
  239. package/lib/index.js.map +1 -1
  240. package/lib/services.d.ts +993 -0
  241. package/lib/services.d.ts.map +1 -0
  242. package/lib/services.js +3600 -0
  243. package/lib/services.js.map +1 -0
  244. package/lib/util.d.ts +5 -0
  245. package/lib/util.d.ts.map +1 -0
  246. package/lib/util.js +53 -0
  247. package/lib/util.js.map +1 -0
  248. package/package.json +2 -2
  249. package/src/client.ts +322 -0
  250. package/src/{types.ts → datatypes.ts} +760 -689
  251. package/src/index.ts +2 -1775
  252. package/src/services.ts +3380 -0
  253. package/src/util.ts +48 -0
  254. package/test/apikey.test.js +41 -30
  255. package/docs/classes/ngrok.html +0 -5028
  256. package/docs/interfaces/endpointbackendmutate.html +0 -119
  257. package/docs/interfaces/endpointcircuitbreakerreplace.html +0 -164
  258. package/docs/interfaces/endpointcompressionreplace.html +0 -164
  259. package/docs/interfaces/endpointconfigurationupdate.html +0 -421
  260. package/docs/interfaces/endpointloggingreplace.html +0 -164
  261. package/docs/interfaces/endpointmutualtlsreplace.html +0 -164
  262. package/docs/interfaces/endpointoidcreplace.html +0 -164
  263. package/docs/interfaces/endpointrequestheadersreplace.html +0 -164
  264. package/docs/interfaces/endpointsamlreplace.html +0 -164
  265. package/docs/interfaces/endpointtlsterminationreplace.html +0 -164
  266. package/docs/interfaces/endpointwebhookvalidationreplace.html +0 -164
  267. package/docs/interfaces/eventstreamcreate.html +0 -250
  268. package/docs/interfaces/eventstreamlist.html +0 -193
  269. package/docs/interfaces/eventtargetdebug.html +0 -119
  270. package/docs/interfaces/eventtargets3.html +0 -250
  271. package/docs/interfaces/ipwhitelistentry.html +0 -250
  272. package/docs/interfaces/ipwhitelistentrylist.html +0 -193
  273. package/docs/interfaces/prioritybackend.html +0 -231
  274. package/docs/interfaces/reservedaddrupdate.html +0 -207
  275. package/docs/interfaces/rootresponse.html +0 -164
  276. package/docs/interfaces/sentevent.html +0 -150
  277. package/docs/interfaces/staticbackendcreate.html +0 -212
  278. package/docs/interfaces/tcpedgecreate.html +0 -188
  279. package/docs/interfaces/tcpedgeupdate.html +0 -207
  280. package/docs/interfaces/tunnel.html +0 -269
  281. package/lib/types.d.ts.map +0 -1
  282. package/lib/types.js.map +0 -1
  283. package/test/endpointConfigurations.test.js +0 -63
package/docs/classes/client.Ngrok.html ADDED
@@ -0,0 +1,772 @@
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>Ngrok | @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/client.html">client</a>
59
+ </li>
60
+ <li>
61
+ <a href="client.Ngrok.html">Ngrok</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Class Ngrok</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">Ngrok</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>Constructors</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="client.Ngrok.html#constructor" class="tsd-kind-icon">constructor</a></li>
87
+ </ul>
88
+ </section>
89
+ <section class="tsd-index-section ">
90
+ <h3>Properties</h3>
91
+ <ul class="tsd-index-list">
92
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#abuseReports" class="tsd-kind-icon">abuse<wbr>Reports</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#agentIngresses" class="tsd-kind-icon">agent<wbr>Ingresses</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#backends" class="tsd-kind-icon">backends</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#credentials" class="tsd-kind-icon">credentials</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#edgeModules" class="tsd-kind-icon">edge<wbr>Modules</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#edges" class="tsd-kind-icon">edges</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#endpoints" class="tsd-kind-icon">endpoints</a></li>
101
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventDestinations" class="tsd-kind-icon">event<wbr>Destinations</a></li>
102
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventSources" class="tsd-kind-icon">event<wbr>Sources</a></li>
103
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#eventSubscriptions" class="tsd-kind-icon">event<wbr>Subscriptions</a></li>
104
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a></li>
105
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipPolicyRules" class="tsd-kind-icon">ip<wbr>Policy<wbr>Rules</a></li>
106
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a></li>
107
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#reservedAddrs" class="tsd-kind-icon">reserved<wbr>Addrs</a></li>
108
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#reservedDomains" class="tsd-kind-icon">reserved<wbr>Domains</a></li>
109
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#sshCertificateAuthorities" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authorities</a></li>
110
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#sshCredentials" class="tsd-kind-icon">ssh<wbr>Credentials</a></li>
111
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#sshHostCertificates" class="tsd-kind-icon">ssh<wbr>Host<wbr>Certificates</a></li>
112
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#sshUserCertificates" class="tsd-kind-icon">ssh<wbr>User<wbr>Certificates</a></li>
113
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#tlsCertificates" class="tsd-kind-icon">tls<wbr>Certificates</a></li>
114
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#tunnelSessions" class="tsd-kind-icon">tunnel<wbr>Sessions</a></li>
115
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#tunnels" class="tsd-kind-icon">tunnels</a></li>
116
+ </ul>
117
+ </section>
118
+ </div>
119
+ </section>
120
+ </section>
121
+ <section class="tsd-panel-group tsd-member-group ">
122
+ <h2>Constructors</h2>
123
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
124
+ <a name="constructor" class="tsd-anchor"></a>
125
+ <h3>constructor</h3>
126
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
127
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Ngrok<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/client.NgrokConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NgrokConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client.Ngrok.html" class="tsd-signature-type" data-tsd-kind="Class">Ngrok</a></li>
128
+ </ul>
129
+ <ul class="tsd-descriptions">
130
+ <li class="tsd-description">
131
+ <aside class="tsd-sources">
132
+ <ul>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L192">client.ts:192</a></li>
134
+ </ul>
135
+ </aside>
136
+ <div class="tsd-comment tsd-typography">
137
+ <div class="lead">
138
+ <p>Creates an instance of the Ngrok HTTP API client</p>
139
+ </div>
140
+ </div>
141
+ <h4 class="tsd-parameters-title">Parameters</h4>
142
+ <ul class="tsd-parameters">
143
+ <li>
144
+ <h5>__namedParameters: <a href="../interfaces/client.NgrokConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">NgrokConfig</a></h5>
145
+ </li>
146
+ </ul>
147
+ <h4 class="tsd-returns-title">Returns <a href="client.Ngrok.html" class="tsd-signature-type" data-tsd-kind="Class">Ngrok</a></h4>
148
+ </li>
149
+ </ul>
150
+ </section>
151
+ </section>
152
+ <section class="tsd-panel-group tsd-member-group ">
153
+ <h2>Properties</h2>
154
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
155
+ <a name="abuseReports" class="tsd-anchor"></a>
156
+ <h3>abuse<wbr>Reports</h3>
157
+ <div class="tsd-signature tsd-kind-icon">abuse<wbr>Reports<span class="tsd-signature-symbol">:</span> <a href="services.AbuseReports.html" class="tsd-signature-type" data-tsd-kind="Class">AbuseReports</a></div>
158
+ <aside class="tsd-sources">
159
+ <ul>
160
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L28">client.ts:28</a></li>
161
+ </ul>
162
+ </aside>
163
+ <div class="tsd-comment tsd-typography">
164
+ <div class="lead">
165
+ <p>Abuse Reports allow you to submit take-down requests for URLs hosted by
166
+ ngrok that violate ngrok&#39;s terms of service.</p>
167
+ </div>
168
+ </div>
169
+ </section>
170
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
171
+ <a name="agentIngresses" class="tsd-anchor"></a>
172
+ <h3>agent<wbr>Ingresses</h3>
173
+ <div class="tsd-signature tsd-kind-icon">agent<wbr>Ingresses<span class="tsd-signature-symbol">:</span> <a href="services.AgentIngresses.html" class="tsd-signature-type" data-tsd-kind="Class">AgentIngresses</a></div>
174
+ <aside class="tsd-sources">
175
+ <ul>
176
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L29">client.ts:29</a></li>
177
+ </ul>
178
+ </aside>
179
+ </section>
180
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
181
+ <a name="apiKeys" class="tsd-anchor"></a>
182
+ <h3>api<wbr>Keys</h3>
183
+ <div class="tsd-signature tsd-kind-icon">api<wbr>Keys<span class="tsd-signature-symbol">:</span> <a href="services.APIKeys.html" class="tsd-signature-type" data-tsd-kind="Class">APIKeys</a></div>
184
+ <aside class="tsd-sources">
185
+ <ul>
186
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L37">client.ts:37</a></li>
187
+ </ul>
188
+ </aside>
189
+ <div class="tsd-comment tsd-typography">
190
+ <div class="lead">
191
+ <p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok
192
+ API</a>. You may use the API itself
193
+ to provision and manage API Keys but you&#39;ll need to provision your first API
194
+ key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your
195
+ ngrok.com dashboard.</p>
196
+ </div>
197
+ </div>
198
+ </section>
199
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
200
+ <a name="backends" class="tsd-anchor"></a>
201
+ <h3>backends</h3>
202
+ <div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>failoverBackends<span class="tsd-signature-symbol">: </span><a href="services.FailoverBackends.html" class="tsd-signature-type" data-tsd-kind="Class">FailoverBackends</a><span class="tsd-signature-symbol">; </span>httpResponseBackends<span class="tsd-signature-symbol">: </span><a href="services.HTTPResponseBackends.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPResponseBackends</a><span class="tsd-signature-symbol">; </span>tunnelGroupBackends<span class="tsd-signature-symbol">: </span><a href="services.TunnelGroupBackends.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelGroupBackends</a><span class="tsd-signature-symbol">; </span>weightedBackends<span class="tsd-signature-symbol">: </span><a href="services.WeightedBackends.html" class="tsd-signature-type" data-tsd-kind="Class">WeightedBackends</a><span class="tsd-signature-symbol"> }</span></div>
203
+ <aside class="tsd-sources">
204
+ <ul>
205
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L137">client.ts:137</a></li>
206
+ </ul>
207
+ </aside>
208
+ <div class="tsd-type-declaration">
209
+ <h4>Type declaration</h4>
210
+ <ul class="tsd-parameters">
211
+ <li class="tsd-parameter">
212
+ <h5>failover<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.FailoverBackends.html" class="tsd-signature-type" data-tsd-kind="Class">FailoverBackends</a></h5>
213
+ <div class="tsd-comment tsd-typography">
214
+ <div class="lead">
215
+ <p>A Failover backend defines failover behavior within a list of referenced
216
+ backends. Traffic is sent to the first backend in the list. If that backend
217
+ is offline or no connection can be established, ngrok attempts to connect to
218
+ the next backend in the list until one is successful.</p>
219
+ </div>
220
+ </div>
221
+ </li>
222
+ <li class="tsd-parameter">
223
+ <h5>http<wbr>Response<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.HTTPResponseBackends.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPResponseBackends</a></h5>
224
+ </li>
225
+ <li class="tsd-parameter">
226
+ <h5>tunnel<wbr>Group<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.TunnelGroupBackends.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelGroupBackends</a></h5>
227
+ <div class="tsd-comment tsd-typography">
228
+ <div class="lead">
229
+ <p>A Tunnel Group Backend balances traffic among all online tunnels that match
230
+ a label selector.</p>
231
+ </div>
232
+ </div>
233
+ </li>
234
+ <li class="tsd-parameter">
235
+ <h5>weighted<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.WeightedBackends.html" class="tsd-signature-type" data-tsd-kind="Class">WeightedBackends</a></h5>
236
+ <div class="tsd-comment tsd-typography">
237
+ <div class="lead">
238
+ <p>A Weighted Backend balances traffic among the referenced backends. Traffic
239
+ is assigned proportionally to each based on its weight. The percentage of
240
+ traffic is calculated by dividing a backend&#39;s weight by the sum of all
241
+ weights.</p>
242
+ </div>
243
+ </div>
244
+ </li>
245
+ </ul>
246
+ </div>
247
+ </section>
248
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
249
+ <a name="certificateAuthorities" class="tsd-anchor"></a>
250
+ <h3>certificate<wbr>Authorities</h3>
251
+ <div class="tsd-signature tsd-kind-icon">certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="services.CertificateAuthorities.html" class="tsd-signature-type" data-tsd-kind="Class">CertificateAuthorities</a></div>
252
+ <aside class="tsd-sources">
253
+ <ul>
254
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L45">client.ts:45</a></li>
255
+ </ul>
256
+ </aside>
257
+ <div class="tsd-comment tsd-typography">
258
+ <div class="lead">
259
+ <p>Certificate Authorities are x509 certificates that are used to sign other
260
+ x509 certificates. Attach a Certificate Authority to the Mutual TLS module
261
+ to verify that the TLS certificate presented by a client has been signed by
262
+ this CA. Certificate Authorities are used only for mTLS validation only and
263
+ thus a private key is not included in the resource.</p>
264
+ </div>
265
+ </div>
266
+ </section>
267
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
268
+ <a name="credentials" class="tsd-anchor"></a>
269
+ <h3>credentials</h3>
270
+ <div class="tsd-signature tsd-kind-icon">credentials<span class="tsd-signature-symbol">:</span> <a href="services.Credentials.html" class="tsd-signature-type" data-tsd-kind="Class">Credentials</a></div>
271
+ <aside class="tsd-sources">
272
+ <ul>
273
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L52">client.ts:52</a></li>
274
+ </ul>
275
+ </aside>
276
+ <div class="tsd-comment tsd-typography">
277
+ <div class="lead">
278
+ <p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
279
+ agent to connect the ngrok service as your account. They are installed with
280
+ the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code>
281
+ configuration file with the <code>authtoken</code> property.</p>
282
+ </div>
283
+ </div>
284
+ </section>
285
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
286
+ <a name="edgeModules" class="tsd-anchor"></a>
287
+ <h3>edge<wbr>Modules</h3>
288
+ <div class="tsd-signature tsd-kind-icon">edge<wbr>Modules<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>edgeRouteBackendModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteBackendModule</a><span class="tsd-signature-symbol">; </span>edgeRouteCircuitBreakerModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCircuitBreakerModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCircuitBreakerModule</a><span class="tsd-signature-symbol">; </span>edgeRouteCompressionModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCompressionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCompressionModule</a><span class="tsd-signature-symbol">; </span>edgeRouteIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>edgeRouteOAuthModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOAuthModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOAuthModule</a><span class="tsd-signature-symbol">; </span>edgeRouteOidcModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOIDCModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOIDCModule</a><span class="tsd-signature-symbol">; </span>edgeRouteRequestHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteRequestHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteRequestHeadersModule</a><span class="tsd-signature-symbol">; </span>edgeRouteResponseHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteResponseHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteResponseHeadersModule</a><span class="tsd-signature-symbol">; </span>edgeRouteSamlModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteSAMLModule</a><span class="tsd-signature-symbol">; </span>edgeRouteWebhookVerificationModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebhookVerificationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebhookVerificationModule</a><span class="tsd-signature-symbol">; </span>edgeRouteWebsocketTcpConverterModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebsocketTCPConverterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebsocketTCPConverterModule</a><span class="tsd-signature-symbol">; </span>httpsEdgeMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeMutualTLSModule</a><span class="tsd-signature-symbol">; </span>httpsEdgeTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeTLSTerminationModule</a><span class="tsd-signature-symbol">; </span>tcpEdgeBackendModule<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeBackendModule</a><span class="tsd-signature-symbol">; </span>tcpEdgeIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeBackendModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeBackendModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeMutualTLSModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeTLSTerminationModule</a><span class="tsd-signature-symbol"> }</span></div>
289
+ <aside class="tsd-sources">
290
+ <ul>
291
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L165">client.ts:165</a></li>
292
+ </ul>
293
+ </aside>
294
+ <div class="tsd-type-declaration">
295
+ <h4>Type declaration</h4>
296
+ <ul class="tsd-parameters">
297
+ <li class="tsd-parameter">
298
+ <h5>edge<wbr>Route<wbr>Backend<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteBackendModule</a></h5>
299
+ </li>
300
+ <li class="tsd-parameter">
301
+ <h5>edge<wbr>Route<wbr>Circuit<wbr>Breaker<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCircuitBreakerModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCircuitBreakerModule</a></h5>
302
+ </li>
303
+ <li class="tsd-parameter">
304
+ <h5>edge<wbr>Route<wbr>Compression<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCompressionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCompressionModule</a></h5>
305
+ </li>
306
+ <li class="tsd-parameter">
307
+ <h5>edge<wbr>Route<wbr>IpRestriction<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteIPRestrictionModule</a></h5>
308
+ </li>
309
+ <li class="tsd-parameter">
310
+ <h5>edge<wbr>RouteOAuth<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOAuthModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOAuthModule</a></h5>
311
+ </li>
312
+ <li class="tsd-parameter">
313
+ <h5>edge<wbr>Route<wbr>Oidc<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOIDCModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOIDCModule</a></h5>
314
+ </li>
315
+ <li class="tsd-parameter">
316
+ <h5>edge<wbr>Route<wbr>Request<wbr>Headers<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteRequestHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteRequestHeadersModule</a></h5>
317
+ </li>
318
+ <li class="tsd-parameter">
319
+ <h5>edge<wbr>Route<wbr>Response<wbr>Headers<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteResponseHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteResponseHeadersModule</a></h5>
320
+ </li>
321
+ <li class="tsd-parameter">
322
+ <h5>edge<wbr>Route<wbr>Saml<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteSAMLModule</a></h5>
323
+ </li>
324
+ <li class="tsd-parameter">
325
+ <h5>edge<wbr>Route<wbr>Webhook<wbr>Verification<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebhookVerificationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebhookVerificationModule</a></h5>
326
+ </li>
327
+ <li class="tsd-parameter">
328
+ <h5>edge<wbr>Route<wbr>Websocket<wbr>Tcp<wbr>Converter<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebsocketTCPConverterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebsocketTCPConverterModule</a></h5>
329
+ </li>
330
+ <li class="tsd-parameter">
331
+ <h5>https<wbr>Edge<wbr>Mutual<wbr>Tls<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeMutualTLSModule</a></h5>
332
+ </li>
333
+ <li class="tsd-parameter">
334
+ <h5>https<wbr>Edge<wbr>Tls<wbr>Termination<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeTLSTerminationModule</a></h5>
335
+ </li>
336
+ <li class="tsd-parameter">
337
+ <h5>tcp<wbr>Edge<wbr>Backend<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeBackendModule</a></h5>
338
+ </li>
339
+ <li class="tsd-parameter">
340
+ <h5>tcp<wbr>Edge<wbr>IpRestriction<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeIPRestrictionModule</a></h5>
341
+ </li>
342
+ <li class="tsd-parameter">
343
+ <h5>tls<wbr>Edge<wbr>Backend<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeBackendModule</a></h5>
344
+ </li>
345
+ <li class="tsd-parameter">
346
+ <h5>tls<wbr>Edge<wbr>IpRestriction<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeIPRestrictionModule</a></h5>
347
+ </li>
348
+ <li class="tsd-parameter">
349
+ <h5>tls<wbr>Edge<wbr>Mutual<wbr>Tls<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeMutualTLSModule</a></h5>
350
+ </li>
351
+ <li class="tsd-parameter">
352
+ <h5>tls<wbr>Edge<wbr>Tls<wbr>Termination<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeTLSTerminationModule</a></h5>
353
+ </li>
354
+ </ul>
355
+ </div>
356
+ </section>
357
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
358
+ <a name="edges" class="tsd-anchor"></a>
359
+ <h3>edges</h3>
360
+ <div class="tsd-signature tsd-kind-icon">edges<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>edgesHttps<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPS</a><span class="tsd-signature-symbol">; </span>edgesHttpsRoutes<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPSRoutes.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPSRoutes</a><span class="tsd-signature-symbol">; </span>edgesTcp<span class="tsd-signature-symbol">: </span><a href="services.EdgesTCP.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTCP</a><span class="tsd-signature-symbol">; </span>edgesTls<span class="tsd-signature-symbol">: </span><a href="services.EdgesTLS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTLS</a><span class="tsd-signature-symbol"> }</span></div>
361
+ <aside class="tsd-sources">
362
+ <ul>
363
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L159">client.ts:159</a></li>
364
+ </ul>
365
+ </aside>
366
+ <div class="tsd-type-declaration">
367
+ <h4>Type declaration</h4>
368
+ <ul class="tsd-parameters">
369
+ <li class="tsd-parameter">
370
+ <h5>edges<wbr>Https<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPS</a></h5>
371
+ </li>
372
+ <li class="tsd-parameter">
373
+ <h5>edges<wbr>Https<wbr>Routes<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPSRoutes.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPSRoutes</a></h5>
374
+ </li>
375
+ <li class="tsd-parameter">
376
+ <h5>edges<wbr>Tcp<span class="tsd-signature-symbol">: </span><a href="services.EdgesTCP.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTCP</a></h5>
377
+ </li>
378
+ <li class="tsd-parameter">
379
+ <h5>edges<wbr>Tls<span class="tsd-signature-symbol">: </span><a href="services.EdgesTLS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTLS</a></h5>
380
+ </li>
381
+ </ul>
382
+ </div>
383
+ </section>
384
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
385
+ <a name="endpoints" class="tsd-anchor"></a>
386
+ <h3>endpoints</h3>
387
+ <div class="tsd-signature tsd-kind-icon">endpoints<span class="tsd-signature-symbol">:</span> <a href="services.Endpoints.html" class="tsd-signature-type" data-tsd-kind="Class">Endpoints</a></div>
388
+ <aside class="tsd-sources">
389
+ <ul>
390
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L58">client.ts:58</a></li>
391
+ </ul>
392
+ </aside>
393
+ <div class="tsd-comment tsd-typography">
394
+ <div class="lead">
395
+ <p>Endpoints provides an API for querying the endpoint objects
396
+ which define what tunnel or edge is used to serve a hostport.
397
+ Only active endpoints associated with a tunnel or backend are returned.</p>
398
+ </div>
399
+ </div>
400
+ </section>
401
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
402
+ <a name="eventDestinations" class="tsd-anchor"></a>
403
+ <h3>event<wbr>Destinations</h3>
404
+ <div class="tsd-signature tsd-kind-icon">event<wbr>Destinations<span class="tsd-signature-symbol">:</span> <a href="services.EventDestinations.html" class="tsd-signature-type" data-tsd-kind="Class">EventDestinations</a></div>
405
+ <aside class="tsd-sources">
406
+ <ul>
407
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L59">client.ts:59</a></li>
408
+ </ul>
409
+ </aside>
410
+ </section>
411
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
412
+ <a name="eventSources" class="tsd-anchor"></a>
413
+ <h3>event<wbr>Sources</h3>
414
+ <div class="tsd-signature tsd-kind-icon">event<wbr>Sources<span class="tsd-signature-symbol">:</span> <a href="services.EventSources.html" class="tsd-signature-type" data-tsd-kind="Class">EventSources</a></div>
415
+ <aside class="tsd-sources">
416
+ <ul>
417
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L61">client.ts:61</a></li>
418
+ </ul>
419
+ </aside>
420
+ </section>
421
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
422
+ <a name="eventSubscriptions" class="tsd-anchor"></a>
423
+ <h3>event<wbr>Subscriptions</h3>
424
+ <div class="tsd-signature tsd-kind-icon">event<wbr>Subscriptions<span class="tsd-signature-symbol">:</span> <a href="services.EventSubscriptions.html" class="tsd-signature-type" data-tsd-kind="Class">EventSubscriptions</a></div>
425
+ <aside class="tsd-sources">
426
+ <ul>
427
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L60">client.ts:60</a></li>
428
+ </ul>
429
+ </aside>
430
+ </section>
431
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
432
+ <a name="ipPolicies" class="tsd-anchor"></a>
433
+ <h3>ip<wbr>Policies</h3>
434
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="services.IPPolicies.html" class="tsd-signature-type" data-tsd-kind="Class">IPPolicies</a></div>
435
+ <aside class="tsd-sources">
436
+ <ul>
437
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L68">client.ts:68</a></li>
438
+ </ul>
439
+ </aside>
440
+ <div class="tsd-comment tsd-typography">
441
+ <div class="lead">
442
+ <p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code>
443
+ action. They can be attached to endpoints via the Endpoint Configuration IP
444
+ Policy module. They can also be used with IP Restrictions to control source
445
+ IP ranges that can start tunnel sessions and connect to the API and dashboard.</p>
446
+ </div>
447
+ </div>
448
+ </section>
449
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
450
+ <a name="ipPolicyRules" class="tsd-anchor"></a>
451
+ <h3>ip<wbr>Policy<wbr>Rules</h3>
452
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Rules<span class="tsd-signature-symbol">:</span> <a href="services.IPPolicyRules.html" class="tsd-signature-type" data-tsd-kind="Class">IPPolicyRules</a></div>
453
+ <aside class="tsd-sources">
454
+ <ul>
455
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L73">client.ts:73</a></li>
456
+ </ul>
457
+ </aside>
458
+ <div class="tsd-comment tsd-typography">
459
+ <div class="lead">
460
+ <p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
461
+ make up an IP Policy.</p>
462
+ </div>
463
+ </div>
464
+ </section>
465
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
466
+ <a name="ipRestrictions" class="tsd-anchor"></a>
467
+ <h3>ip<wbr>Restrictions</h3>
468
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Restrictions<span class="tsd-signature-symbol">:</span> <a href="services.IPRestrictions.html" class="tsd-signature-type" data-tsd-kind="Class">IPRestrictions</a></div>
469
+ <aside class="tsd-sources">
470
+ <ul>
471
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L82">client.ts:82</a></li>
472
+ </ul>
473
+ </aside>
474
+ <div class="tsd-comment tsd-typography">
475
+ <div class="lead">
476
+ <p>An IP restriction is a restriction placed on the CIDRs that are allowed to
477
+ initiate traffic to a specific aspect of your ngrok account. An IP
478
+ restriction has a type which defines the ingress it applies to. IP
479
+ restrictions can be used to enforce the source IPs that can make API
480
+ requests, log in to the dashboard, start ngrok agents, and connect to your
481
+ public-facing endpoints.</p>
482
+ </div>
483
+ </div>
484
+ </section>
485
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
486
+ <a name="reservedAddrs" class="tsd-anchor"></a>
487
+ <h3>reserved<wbr>Addrs</h3>
488
+ <div class="tsd-signature tsd-kind-icon">reserved<wbr>Addrs<span class="tsd-signature-symbol">:</span> <a href="services.ReservedAddrs.html" class="tsd-signature-type" data-tsd-kind="Class">ReservedAddrs</a></div>
489
+ <aside class="tsd-sources">
490
+ <ul>
491
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L88">client.ts:88</a></li>
492
+ </ul>
493
+ </aside>
494
+ <div class="tsd-comment tsd-typography">
495
+ <div class="lead">
496
+ <p>Reserved Addresses are TCP addresses that can be used to listen for traffic.
497
+ TCP address hostnames and ports are assigned by ngrok, they cannot be
498
+ chosen.</p>
499
+ </div>
500
+ </div>
501
+ </section>
502
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
503
+ <a name="reservedDomains" class="tsd-anchor"></a>
504
+ <h3>reserved<wbr>Domains</h3>
505
+ <div class="tsd-signature tsd-kind-icon">reserved<wbr>Domains<span class="tsd-signature-symbol">:</span> <a href="services.ReservedDomains.html" class="tsd-signature-type" data-tsd-kind="Class">ReservedDomains</a></div>
506
+ <aside class="tsd-sources">
507
+ <ul>
508
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L95">client.ts:95</a></li>
509
+ </ul>
510
+ </aside>
511
+ <div class="tsd-comment tsd-typography">
512
+ <div class="lead">
513
+ <p>Reserved Domains are hostnames that you can listen for traffic on. Domains
514
+ can be used to listen for http, https or tls traffic. You may use a domain
515
+ that you own by creating a CNAME record specified in the returned resource.
516
+ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.</p>
517
+ </div>
518
+ </div>
519
+ </section>
520
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
521
+ <a name="sshCertificateAuthorities" class="tsd-anchor"></a>
522
+ <h3>ssh<wbr>Certificate<wbr>Authorities</h3>
523
+ <div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="services.SSHCertificateAuthorities.html" class="tsd-signature-type" data-tsd-kind="Class">SSHCertificateAuthorities</a></div>
524
+ <aside class="tsd-sources">
525
+ <ul>
526
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L100">client.ts:100</a></li>
527
+ </ul>
528
+ </aside>
529
+ <div class="tsd-comment tsd-typography">
530
+ <div class="lead">
531
+ <p>An SSH Certificate Authority is a pair of an SSH Certificate and its private
532
+ key that can be used to sign other SSH host and user certificates.</p>
533
+ </div>
534
+ </div>
535
+ </section>
536
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
537
+ <a name="sshCredentials" class="tsd-anchor"></a>
538
+ <h3>ssh<wbr>Credentials</h3>
539
+ <div class="tsd-signature tsd-kind-icon">ssh<wbr>Credentials<span class="tsd-signature-symbol">:</span> <a href="services.SSHCredentials.html" class="tsd-signature-type" data-tsd-kind="Class">SSHCredentials</a></div>
540
+ <aside class="tsd-sources">
541
+ <ul>
542
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L105">client.ts:105</a></li>
543
+ </ul>
544
+ </aside>
545
+ <div class="tsd-comment tsd-typography">
546
+ <div class="lead">
547
+ <p>SSH Credentials are SSH public keys that can be used to start SSH tunnels
548
+ via the ngrok SSH tunnel gateway.</p>
549
+ </div>
550
+ </div>
551
+ </section>
552
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
553
+ <a name="sshHostCertificates" class="tsd-anchor"></a>
554
+ <h3>ssh<wbr>Host<wbr>Certificates</h3>
555
+ <div class="tsd-signature tsd-kind-icon">ssh<wbr>Host<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.SSHHostCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">SSHHostCertificates</a></div>
556
+ <aside class="tsd-sources">
557
+ <ul>
558
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L111">client.ts:111</a></li>
559
+ </ul>
560
+ </aside>
561
+ <div class="tsd-comment tsd-typography">
562
+ <div class="lead">
563
+ <p>SSH Host Certificates along with the corresponding private key allows an SSH
564
+ server to assert its authenticity to connecting SSH clients who trust the
565
+ SSH Certificate Authority that was used to sign the certificate.</p>
566
+ </div>
567
+ </div>
568
+ </section>
569
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
570
+ <a name="sshUserCertificates" class="tsd-anchor"></a>
571
+ <h3>ssh<wbr>User<wbr>Certificates</h3>
572
+ <div class="tsd-signature tsd-kind-icon">ssh<wbr>User<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.SSHUserCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">SSHUserCertificates</a></div>
573
+ <aside class="tsd-sources">
574
+ <ul>
575
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L117">client.ts:117</a></li>
576
+ </ul>
577
+ </aside>
578
+ <div class="tsd-comment tsd-typography">
579
+ <div class="lead">
580
+ <p>SSH User Certificates are presented by SSH clients when connecting to an SSH
581
+ server to authenticate their connection. The SSH server must trust the SSH
582
+ Certificate Authority used to sign the certificate.</p>
583
+ </div>
584
+ </div>
585
+ </section>
586
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
587
+ <a name="tlsCertificates" class="tsd-anchor"></a>
588
+ <h3>tls<wbr>Certificates</h3>
589
+ <div class="tsd-signature tsd-kind-icon">tls<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.TLSCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">TLSCertificates</a></div>
590
+ <aside class="tsd-sources">
591
+ <ul>
592
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L125">client.ts:125</a></li>
593
+ </ul>
594
+ </aside>
595
+ <div class="tsd-comment tsd-typography">
596
+ <div class="lead">
597
+ <p>TLS Certificates are pairs of x509 certificates and their matching private
598
+ key that can be used to terminate TLS traffic. TLS certificates are unused
599
+ until they are attached to a Domain. TLS Certificates may also be
600
+ provisioned by ngrok automatically for domains on which you have enabled
601
+ automated certificate provisioning.</p>
602
+ </div>
603
+ </div>
604
+ </section>
605
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
606
+ <a name="tunnelSessions" class="tsd-anchor"></a>
607
+ <h3>tunnel<wbr>Sessions</h3>
608
+ <div class="tsd-signature tsd-kind-icon">tunnel<wbr>Sessions<span class="tsd-signature-symbol">:</span> <a href="services.TunnelSessions.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelSessions</a></div>
609
+ <aside class="tsd-sources">
610
+ <ul>
611
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L131">client.ts:131</a></li>
612
+ </ul>
613
+ </aside>
614
+ <div class="tsd-comment tsd-typography">
615
+ <div class="lead">
616
+ <p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
617
+ sessions that are running and connected to the ngrok service. Each tunnel
618
+ session can include one or more Tunnels.</p>
619
+ </div>
620
+ </div>
621
+ </section>
622
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
623
+ <a name="tunnels" class="tsd-anchor"></a>
624
+ <h3>tunnels</h3>
625
+ <div class="tsd-signature tsd-kind-icon">tunnels<span class="tsd-signature-symbol">:</span> <a href="services.Tunnels.html" class="tsd-signature-type" data-tsd-kind="Class">Tunnels</a></div>
626
+ <aside class="tsd-sources">
627
+ <ul>
628
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L136">client.ts:136</a></li>
629
+ </ul>
630
+ </aside>
631
+ <div class="tsd-comment tsd-typography">
632
+ <div class="lead">
633
+ <p>Tunnels provide endpoints to access services exposed by a running ngrok
634
+ agent tunnel session or an SSH reverse tunnel session.</p>
635
+ </div>
636
+ </div>
637
+ </section>
638
+ </section>
639
+ </div>
640
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
641
+ <nav class="tsd-navigation primary">
642
+ <ul>
643
+ <li class=" ">
644
+ <a href="../modules.html">Modules</a>
645
+ </li>
646
+ <li class="current tsd-kind-module">
647
+ <a href="../modules/client.html">client</a>
648
+ </li>
649
+ <li class=" tsd-kind-module">
650
+ <a href="../modules/datatypes.html">datatypes</a>
651
+ </li>
652
+ <li class=" tsd-kind-module">
653
+ <a href="../modules/services.html">services</a>
654
+ </li>
655
+ </ul>
656
+ </nav>
657
+ <nav class="tsd-navigation secondary menu-sticky">
658
+ <ul class="before-current">
659
+ </ul>
660
+ <ul class="current">
661
+ <li class="current tsd-kind-class tsd-parent-kind-module">
662
+ <a href="client.Ngrok.html" class="tsd-kind-icon">Ngrok</a>
663
+ <ul>
664
+ <li class=" tsd-kind-constructor tsd-parent-kind-class">
665
+ <a href="client.Ngrok.html#constructor" class="tsd-kind-icon">constructor</a>
666
+ </li>
667
+ <li class=" tsd-kind-property tsd-parent-kind-class">
668
+ <a href="client.Ngrok.html#abuseReports" class="tsd-kind-icon">abuse<wbr>Reports</a>
669
+ </li>
670
+ <li class=" tsd-kind-property tsd-parent-kind-class">
671
+ <a href="client.Ngrok.html#agentIngresses" class="tsd-kind-icon">agent<wbr>Ingresses</a>
672
+ </li>
673
+ <li class=" tsd-kind-property tsd-parent-kind-class">
674
+ <a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a>
675
+ </li>
676
+ <li class=" tsd-kind-property tsd-parent-kind-class">
677
+ <a href="client.Ngrok.html#backends" class="tsd-kind-icon">backends</a>
678
+ </li>
679
+ <li class=" tsd-kind-property tsd-parent-kind-class">
680
+ <a href="client.Ngrok.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a>
681
+ </li>
682
+ <li class=" tsd-kind-property tsd-parent-kind-class">
683
+ <a href="client.Ngrok.html#credentials" class="tsd-kind-icon">credentials</a>
684
+ </li>
685
+ <li class=" tsd-kind-property tsd-parent-kind-class">
686
+ <a href="client.Ngrok.html#edgeModules" class="tsd-kind-icon">edge<wbr>Modules</a>
687
+ </li>
688
+ <li class=" tsd-kind-property tsd-parent-kind-class">
689
+ <a href="client.Ngrok.html#edges" class="tsd-kind-icon">edges</a>
690
+ </li>
691
+ <li class=" tsd-kind-property tsd-parent-kind-class">
692
+ <a href="client.Ngrok.html#endpoints" class="tsd-kind-icon">endpoints</a>
693
+ </li>
694
+ <li class=" tsd-kind-property tsd-parent-kind-class">
695
+ <a href="client.Ngrok.html#eventDestinations" class="tsd-kind-icon">event<wbr>Destinations</a>
696
+ </li>
697
+ <li class=" tsd-kind-property tsd-parent-kind-class">
698
+ <a href="client.Ngrok.html#eventSources" class="tsd-kind-icon">event<wbr>Sources</a>
699
+ </li>
700
+ <li class=" tsd-kind-property tsd-parent-kind-class">
701
+ <a href="client.Ngrok.html#eventSubscriptions" class="tsd-kind-icon">event<wbr>Subscriptions</a>
702
+ </li>
703
+ <li class=" tsd-kind-property tsd-parent-kind-class">
704
+ <a href="client.Ngrok.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a>
705
+ </li>
706
+ <li class=" tsd-kind-property tsd-parent-kind-class">
707
+ <a href="client.Ngrok.html#ipPolicyRules" class="tsd-kind-icon">ip<wbr>Policy<wbr>Rules</a>
708
+ </li>
709
+ <li class=" tsd-kind-property tsd-parent-kind-class">
710
+ <a href="client.Ngrok.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a>
711
+ </li>
712
+ <li class=" tsd-kind-property tsd-parent-kind-class">
713
+ <a href="client.Ngrok.html#reservedAddrs" class="tsd-kind-icon">reserved<wbr>Addrs</a>
714
+ </li>
715
+ <li class=" tsd-kind-property tsd-parent-kind-class">
716
+ <a href="client.Ngrok.html#reservedDomains" class="tsd-kind-icon">reserved<wbr>Domains</a>
717
+ </li>
718
+ <li class=" tsd-kind-property tsd-parent-kind-class">
719
+ <a href="client.Ngrok.html#sshCertificateAuthorities" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authorities</a>
720
+ </li>
721
+ <li class=" tsd-kind-property tsd-parent-kind-class">
722
+ <a href="client.Ngrok.html#sshCredentials" class="tsd-kind-icon">ssh<wbr>Credentials</a>
723
+ </li>
724
+ <li class=" tsd-kind-property tsd-parent-kind-class">
725
+ <a href="client.Ngrok.html#sshHostCertificates" class="tsd-kind-icon">ssh<wbr>Host<wbr>Certificates</a>
726
+ </li>
727
+ <li class=" tsd-kind-property tsd-parent-kind-class">
728
+ <a href="client.Ngrok.html#sshUserCertificates" class="tsd-kind-icon">ssh<wbr>User<wbr>Certificates</a>
729
+ </li>
730
+ <li class=" tsd-kind-property tsd-parent-kind-class">
731
+ <a href="client.Ngrok.html#tlsCertificates" class="tsd-kind-icon">tls<wbr>Certificates</a>
732
+ </li>
733
+ <li class=" tsd-kind-property tsd-parent-kind-class">
734
+ <a href="client.Ngrok.html#tunnelSessions" class="tsd-kind-icon">tunnel<wbr>Sessions</a>
735
+ </li>
736
+ <li class=" tsd-kind-property tsd-parent-kind-class">
737
+ <a href="client.Ngrok.html#tunnels" class="tsd-kind-icon">tunnels</a>
738
+ </li>
739
+ </ul>
740
+ </li>
741
+ </ul>
742
+ <ul class="after-current">
743
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
744
+ <a href="../interfaces/client.NgrokConfig.html" class="tsd-kind-icon">Ngrok<wbr>Config</a>
745
+ </li>
746
+ </ul>
747
+ </nav>
748
+ </div>
749
+ </div>
750
+ </div>
751
+ <footer class="with-border-bottom">
752
+ <div class="container">
753
+ <h2>Legend</h2>
754
+ <div class="tsd-legend-group">
755
+ <ul class="tsd-legend">
756
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
757
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
758
+ <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
759
+ </ul>
760
+ <ul class="tsd-legend">
761
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
762
+ </ul>
763
+ </div>
764
+ </div>
765
+ </footer>
766
+ <div class="container tsd-generator">
767
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
768
+ </div>
769
+ <div class="overlay"></div>
770
+ <script src="../assets/js/main.js"></script>
771
+ </body>
772
+ </html>