@ngrok/ngrok-api 0.0.9 → 0.3.0

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