ngrok-api 0.9.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.
- checksums.yaml +7 -0
- data/.github/workflows/ci.yml +21 -0
- data/.gitignore +13 -0
- data/.rubocop.yml +28 -0
- data/.rubocop_airbnb.yml +2 -0
- data/.simplecov +1 -0
- data/Gemfile +33 -0
- data/Guardfile +16 -0
- data/README.md +61 -0
- data/Rakefile +7 -0
- data/doc/NgrokAPI/Client.html +542 -0
- data/doc/NgrokAPI/Error.html +305 -0
- data/doc/NgrokAPI/Errors/NotFoundError.html +309 -0
- data/doc/NgrokAPI/Errors.html +115 -0
- data/doc/NgrokAPI/HttpClient.html +1104 -0
- data/doc/NgrokAPI/Models/ApiKey.html +1138 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
- data/doc/NgrokAPI/Models/Listable.html +934 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +2498 -0
- data/doc/NgrokAPI/Models/TlsCertificate.html +1064 -0
- data/doc/NgrokAPI/Models.html +117 -0
- data/doc/NgrokAPI/PagedIterator.html +631 -0
- data/doc/NgrokAPI/Services/ApiKeysClient.html +1333 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
- data/doc/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
- data/doc/NgrokAPI/Services.html +117 -0
- data/doc/NgrokAPI.html +157 -0
- data/doc/_index.html +309 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +497 -0
- data/doc/file.README.html +126 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +126 -0
- data/doc/js/app.js +314 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1227 -0
- data/doc/top-level-namespace.html +110 -0
- data/docs/NgrokAPI/Client.html +542 -0
- data/docs/NgrokAPI/Error.html +305 -0
- data/docs/NgrokAPI/Errors/NotFoundError.html +309 -0
- data/docs/NgrokAPI/Errors.html +115 -0
- data/docs/NgrokAPI/HttpClient.html +1104 -0
- data/docs/NgrokAPI/Models/ApiKey.html +1138 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
- data/docs/NgrokAPI/Models/Listable.html +934 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +2498 -0
- data/docs/NgrokAPI/Models/TlsCertificate.html +1064 -0
- data/docs/NgrokAPI/Models.html +117 -0
- data/docs/NgrokAPI/PagedIterator.html +631 -0
- data/docs/NgrokAPI/Services/ApiKeysClient.html +1333 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
- data/docs/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
- data/docs/NgrokAPI/Services.html +117 -0
- data/docs/NgrokAPI.html +157 -0
- data/docs/_index.html +309 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +497 -0
- data/docs/file.README.html +126 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +126 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1227 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/ngrokapi/client.rb +49 -0
- data/lib/ngrokapi/error.rb +14 -0
- data/lib/ngrokapi/errors/not_found_error.rb +16 -0
- data/lib/ngrokapi/http_client.rb +132 -0
- data/lib/ngrokapi/models/api_key.rb +64 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +119 -0
- data/lib/ngrokapi/models/listable.rb +42 -0
- data/lib/ngrokapi/models/reserved_domain.rb +211 -0
- data/lib/ngrokapi/models/tls_certificate.rb +62 -0
- data/lib/ngrokapi/paged_iterator.rb +40 -0
- data/lib/ngrokapi/services/api_keys_client.rb +144 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +313 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +313 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +161 -0
- data/lib/ngrokapi/version.rb +7 -0
- data/lib/ngrokapi.rb +13 -0
- data/ngrok-api.gemspec +27 -0
- data/spec/ngrokapi/client_spec.rb +33 -0
- data/spec/ngrokapi/http_client_spec.rb +75 -0
- data/spec/ngrokapi/models/api_key_spec.rb +43 -0
- data/spec/ngrokapi/models/listable_spec.rb +43 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +100 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +84 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +127 -0
- data/spec/spec_helper.rb +80 -0
- metadata +144 -0
|
@@ -0,0 +1,2541 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: NgrokAPI::Services::ReservedDomainsClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.26
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "NgrokAPI::Services::ReservedDomainsClient";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (R)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">ReservedDomainsClient</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::ReservedDomainsClient
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">NgrokAPI::Services::ReservedDomainsClient</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/ngrokapi/services/reserved_domains_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>A client for interacting with the reserved_domains API</p>
|
|
106
|
+
|
|
107
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains">ngrok.com/docs/api#api-reserved-domains</a></p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
<h2>
|
|
118
|
+
Constant Summary
|
|
119
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
120
|
+
</h2>
|
|
121
|
+
|
|
122
|
+
<dl class="constants">
|
|
123
|
+
|
|
124
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
125
|
+
<div class="docstring">
|
|
126
|
+
<div class="discussion">
|
|
127
|
+
|
|
128
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
</div>
|
|
133
|
+
<div class="tags">
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
</div>
|
|
137
|
+
</dt>
|
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>reserved_domains</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
139
|
+
|
|
140
|
+
<dt id="PATH-constant" class="">PATH =
|
|
141
|
+
<div class="docstring">
|
|
142
|
+
<div class="discussion">
|
|
143
|
+
|
|
144
|
+
<p>The API path for reserved domains</p>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</div>
|
|
148
|
+
</div>
|
|
149
|
+
<div class="tags">
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</div>
|
|
153
|
+
</dt>
|
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
155
|
+
|
|
156
|
+
</dl>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
163
|
+
<ul class="summary">
|
|
164
|
+
|
|
165
|
+
<li class="public ">
|
|
166
|
+
<span class="summary_signature">
|
|
167
|
+
|
|
168
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</span>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<span class="note title readonly">readonly</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class="summary_desc"><div class='inline'>
|
|
188
|
+
<p>Returns the value of attribute client.</p>
|
|
189
|
+
</div></span>
|
|
190
|
+
|
|
191
|
+
</li>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
</ul>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<h2>
|
|
201
|
+
Instance Method Summary
|
|
202
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
203
|
+
</h2>
|
|
204
|
+
|
|
205
|
+
<ul class="summary">
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(name: '', region: '', description: '', metadata: '', http_endpoint_configuration_id: '', https_endpoint_configuration_id: '', certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain </a>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
|
225
|
+
<p>Create a new reserved domain.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: nil) ⇒ nil </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>Delete a reserved domain.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: nil) ⇒ nil </a>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
|
273
|
+
<p>Delete a reserved domain.</p>
|
|
274
|
+
</div></span>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<li class="public ">
|
|
280
|
+
<span class="summary_signature">
|
|
281
|
+
|
|
282
|
+
<a href="#delete_certificate-instance_method" title="#delete_certificate (instance method)">#<strong>delete_certificate</strong>(id: nil) ⇒ nil </a>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
</span>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
|
297
|
+
<p>Detach the certificate attached from a reserved domain.</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<a href="#delete_certificate!-instance_method" title="#delete_certificate! (instance method)">#<strong>delete_certificate!</strong>(id: nil) ⇒ nil </a>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class="summary_desc"><div class='inline'>
|
|
321
|
+
<p>Detach the certificate attached from a reserved domain.</p>
|
|
322
|
+
</div></span>
|
|
323
|
+
|
|
324
|
+
</li>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<li class="public ">
|
|
328
|
+
<span class="summary_signature">
|
|
329
|
+
|
|
330
|
+
<a href="#delete_certificate_management_policy-instance_method" title="#delete_certificate_management_policy (instance method)">#<strong>delete_certificate_management_policy</strong>(id: nil) ⇒ nil </a>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</span>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<span class="summary_desc"><div class='inline'>
|
|
345
|
+
<p>Detach the certificate management policy attached from a reserved domain.</p>
|
|
346
|
+
</div></span>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<li class="public ">
|
|
352
|
+
<span class="summary_signature">
|
|
353
|
+
|
|
354
|
+
<a href="#delete_certificate_management_policy!-instance_method" title="#delete_certificate_management_policy! (instance method)">#<strong>delete_certificate_management_policy!</strong>(id: nil) ⇒ nil </a>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</span>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
|
369
|
+
<p>Detach the certificate management policy attached from a reserved domain.</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<li class="public ">
|
|
376
|
+
<span class="summary_signature">
|
|
377
|
+
|
|
378
|
+
<a href="#delete_http_endpoint_config-instance_method" title="#delete_http_endpoint_config (instance method)">#<strong>delete_http_endpoint_config</strong>(id: nil) ⇒ nil </a>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</span>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<span class="summary_desc"><div class='inline'>
|
|
393
|
+
<p>Detach the http endpoint configuration attached from a reserved domain.</p>
|
|
394
|
+
</div></span>
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<li class="public ">
|
|
400
|
+
<span class="summary_signature">
|
|
401
|
+
|
|
402
|
+
<a href="#delete_http_endpoint_config!-instance_method" title="#delete_http_endpoint_config! (instance method)">#<strong>delete_http_endpoint_config!</strong>(id: nil) ⇒ nil </a>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
</span>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<span class="summary_desc"><div class='inline'>
|
|
417
|
+
<p>Detach the http endpoint configuration attached from a reserved domain.</p>
|
|
418
|
+
</div></span>
|
|
419
|
+
|
|
420
|
+
</li>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<li class="public ">
|
|
424
|
+
<span class="summary_signature">
|
|
425
|
+
|
|
426
|
+
<a href="#delete_https_endpoint_config-instance_method" title="#delete_https_endpoint_config (instance method)">#<strong>delete_https_endpoint_config</strong>(id: nil) ⇒ nil </a>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</span>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<span class="summary_desc"><div class='inline'>
|
|
441
|
+
<p>Detach the https endpoint configuration attached from a reserved domain.</p>
|
|
442
|
+
</div></span>
|
|
443
|
+
|
|
444
|
+
</li>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
<li class="public ">
|
|
448
|
+
<span class="summary_signature">
|
|
449
|
+
|
|
450
|
+
<a href="#delete_https_endpoint_config!-instance_method" title="#delete_https_endpoint_config! (instance method)">#<strong>delete_https_endpoint_config!</strong>(id: nil) ⇒ nil </a>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
</span>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
<span class="summary_desc"><div class='inline'>
|
|
465
|
+
<p>Detach the https endpoint configuration attached from a reserved domain.</p>
|
|
466
|
+
</div></span>
|
|
467
|
+
|
|
468
|
+
</li>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
<li class="public ">
|
|
472
|
+
<span class="summary_signature">
|
|
473
|
+
|
|
474
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: nil) ⇒ NgrokAPI::Models::ReservedDomain </a>
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
</span>
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<span class="summary_desc"><div class='inline'>
|
|
489
|
+
<p>Get the details of a reserved domain.</p>
|
|
490
|
+
</div></span>
|
|
491
|
+
|
|
492
|
+
</li>
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
<li class="public ">
|
|
496
|
+
<span class="summary_signature">
|
|
497
|
+
|
|
498
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: nil) ⇒ NgrokAPI::Models::ReservedDomain </a>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
</span>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
<span class="summary_desc"><div class='inline'>
|
|
513
|
+
<p>Get the details of a reserved domain.</p>
|
|
514
|
+
</div></span>
|
|
515
|
+
|
|
516
|
+
</li>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
<li class="public ">
|
|
520
|
+
<span class="summary_signature">
|
|
521
|
+
|
|
522
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ ReservedDomainsClient </a>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
</span>
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<span class="note title constructor">constructor</span>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
<span class="summary_desc"><div class='inline'>
|
|
539
|
+
<p>A new instance of ReservedDomainsClient.</p>
|
|
540
|
+
</div></span>
|
|
541
|
+
|
|
542
|
+
</li>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
<li class="public ">
|
|
546
|
+
<span class="summary_signature">
|
|
547
|
+
|
|
548
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
</span>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
<span class="summary_desc"><div class='inline'>
|
|
563
|
+
<p>List all reserved domains on this account.</p>
|
|
564
|
+
</div></span>
|
|
565
|
+
|
|
566
|
+
</li>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
<li class="public ">
|
|
570
|
+
<span class="summary_signature">
|
|
571
|
+
|
|
572
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: nil, certificate_id: nil, certificate_management_policy: nil, description: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: nil) ⇒ NgrokAPI::Models::ReservedDomain </a>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
</span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
<span class="summary_desc"><div class='inline'>
|
|
587
|
+
<p>Update the attributes of a reserved domain.</p>
|
|
588
|
+
</div></span>
|
|
589
|
+
|
|
590
|
+
</li>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
<li class="public ">
|
|
594
|
+
<span class="summary_signature">
|
|
595
|
+
|
|
596
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: nil, certificate_id: nil, certificate_management_policy: nil, description: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: nil) ⇒ NgrokAPI::Models::ReservedDomain </a>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</span>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
<span class="summary_desc"><div class='inline'>
|
|
611
|
+
<p>Update the attributes of a reserved domain.</p>
|
|
612
|
+
</div></span>
|
|
613
|
+
|
|
614
|
+
</li>
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
</ul>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
<div id="constructor_details" class="method_details_list">
|
|
621
|
+
<h2>Constructor Details</h2>
|
|
622
|
+
|
|
623
|
+
<div class="method_details first">
|
|
624
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
625
|
+
|
|
626
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></tt>
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
</h3><div class="docstring">
|
|
633
|
+
<div class="discussion">
|
|
634
|
+
|
|
635
|
+
<p>Returns a new instance of ReservedDomainsClient.</p>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
</div>
|
|
639
|
+
</div>
|
|
640
|
+
<div class="tags">
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
</div><table class="source_code">
|
|
644
|
+
<tr>
|
|
645
|
+
<td>
|
|
646
|
+
<pre class="lines">
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
17
|
|
650
|
+
18
|
|
651
|
+
19</pre>
|
|
652
|
+
</td>
|
|
653
|
+
<td>
|
|
654
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 17</span>
|
|
655
|
+
|
|
656
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
657
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
658
|
+
<span class='kw'>end</span></pre>
|
|
659
|
+
</td>
|
|
660
|
+
</tr>
|
|
661
|
+
</table>
|
|
662
|
+
</div>
|
|
663
|
+
|
|
664
|
+
</div>
|
|
665
|
+
|
|
666
|
+
<div id="instance_attr_details" class="attr_details">
|
|
667
|
+
<h2>Instance Attribute Details</h2>
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
<span id=""></span>
|
|
671
|
+
<div class="method_details first">
|
|
672
|
+
<h3 class="signature first" id="client-instance_method">
|
|
673
|
+
|
|
674
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
</h3><div class="docstring">
|
|
681
|
+
<div class="discussion">
|
|
682
|
+
|
|
683
|
+
<p>Returns the value of attribute client.</p>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
</div>
|
|
687
|
+
</div>
|
|
688
|
+
<div class="tags">
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
</div><table class="source_code">
|
|
692
|
+
<tr>
|
|
693
|
+
<td>
|
|
694
|
+
<pre class="lines">
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
15
|
|
698
|
+
16
|
|
699
|
+
17</pre>
|
|
700
|
+
</td>
|
|
701
|
+
<td>
|
|
702
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 15</span>
|
|
703
|
+
|
|
704
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
705
|
+
<span class='ivar'>@client</span>
|
|
706
|
+
<span class='kw'>end</span></pre>
|
|
707
|
+
</td>
|
|
708
|
+
</tr>
|
|
709
|
+
</table>
|
|
710
|
+
</div>
|
|
711
|
+
|
|
712
|
+
</div>
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
<div id="instance_method_details" class="method_details_list">
|
|
716
|
+
<h2>Instance Method Details</h2>
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
<div class="method_details first">
|
|
720
|
+
<h3 class="signature first" id="create-instance_method">
|
|
721
|
+
|
|
722
|
+
#<strong>create</strong>(name: '', region: '', description: '', metadata: '', http_endpoint_configuration_id: '', https_endpoint_configuration_id: '', certificate_id: nil, certificate_management_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
</h3><div class="docstring">
|
|
729
|
+
<div class="discussion">
|
|
730
|
+
|
|
731
|
+
<p>Create a new reserved domain.</p>
|
|
732
|
+
|
|
733
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-create">ngrok.com/docs/api#api-reserved-domains-create</a></p>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</div>
|
|
737
|
+
</div>
|
|
738
|
+
<div class="tags">
|
|
739
|
+
<p class="tag_title">Parameters:</p>
|
|
740
|
+
<ul class="param">
|
|
741
|
+
|
|
742
|
+
<li>
|
|
743
|
+
|
|
744
|
+
<span class='name'>name</span>
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
—
|
|
754
|
+
<div class='inline'>
|
|
755
|
+
<p>the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.</p>
|
|
756
|
+
</div>
|
|
757
|
+
|
|
758
|
+
</li>
|
|
759
|
+
|
|
760
|
+
<li>
|
|
761
|
+
|
|
762
|
+
<span class='name'>region</span>
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
—
|
|
772
|
+
<div class='inline'>
|
|
773
|
+
<p>reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p>
|
|
774
|
+
</div>
|
|
775
|
+
|
|
776
|
+
</li>
|
|
777
|
+
|
|
778
|
+
<li>
|
|
779
|
+
|
|
780
|
+
<span class='name'>description</span>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
—
|
|
790
|
+
<div class='inline'>
|
|
791
|
+
<p>human-readable description of what this reserved domain will be used for</p>
|
|
792
|
+
</div>
|
|
793
|
+
|
|
794
|
+
</li>
|
|
795
|
+
|
|
796
|
+
<li>
|
|
797
|
+
|
|
798
|
+
<span class='name'>metadata</span>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
—
|
|
808
|
+
<div class='inline'>
|
|
809
|
+
<p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
</li>
|
|
813
|
+
|
|
814
|
+
<li>
|
|
815
|
+
|
|
816
|
+
<span class='name'>http_endpoint_configuration_id</span>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
—
|
|
826
|
+
<div class='inline'>
|
|
827
|
+
<p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
|
|
828
|
+
</div>
|
|
829
|
+
|
|
830
|
+
</li>
|
|
831
|
+
|
|
832
|
+
<li>
|
|
833
|
+
|
|
834
|
+
<span class='name'>https_endpoint_configuration_id</span>
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
—
|
|
844
|
+
<div class='inline'>
|
|
845
|
+
<p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
|
|
846
|
+
</div>
|
|
847
|
+
|
|
848
|
+
</li>
|
|
849
|
+
|
|
850
|
+
<li>
|
|
851
|
+
|
|
852
|
+
<span class='name'>certificate_id</span>
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
—
|
|
862
|
+
<div class='inline'>
|
|
863
|
+
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
|
|
864
|
+
</div>
|
|
865
|
+
|
|
866
|
+
</li>
|
|
867
|
+
|
|
868
|
+
<li>
|
|
869
|
+
|
|
870
|
+
<span class='name'>certificate_management_policy</span>
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
—
|
|
880
|
+
<div class='inline'>
|
|
881
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p>
|
|
882
|
+
</div>
|
|
883
|
+
|
|
884
|
+
</li>
|
|
885
|
+
|
|
886
|
+
</ul>
|
|
887
|
+
|
|
888
|
+
<p class="tag_title">Returns:</p>
|
|
889
|
+
<ul class="return">
|
|
890
|
+
|
|
891
|
+
<li>
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
—
|
|
899
|
+
<div class='inline'>
|
|
900
|
+
<p>result from create request</p>
|
|
901
|
+
</div>
|
|
902
|
+
|
|
903
|
+
</li>
|
|
904
|
+
|
|
905
|
+
</ul>
|
|
906
|
+
|
|
907
|
+
</div><table class="source_code">
|
|
908
|
+
<tr>
|
|
909
|
+
<td>
|
|
910
|
+
<pre class="lines">
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
37
|
|
914
|
+
38
|
|
915
|
+
39
|
|
916
|
+
40
|
|
917
|
+
41
|
|
918
|
+
42
|
|
919
|
+
43
|
|
920
|
+
44
|
|
921
|
+
45
|
|
922
|
+
46
|
|
923
|
+
47
|
|
924
|
+
48
|
|
925
|
+
49
|
|
926
|
+
50
|
|
927
|
+
51
|
|
928
|
+
52
|
|
929
|
+
53
|
|
930
|
+
54
|
|
931
|
+
55
|
|
932
|
+
56
|
|
933
|
+
57
|
|
934
|
+
58
|
|
935
|
+
59</pre>
|
|
936
|
+
</td>
|
|
937
|
+
<td>
|
|
938
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 37</span>
|
|
939
|
+
|
|
940
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
941
|
+
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
942
|
+
<span class='label'>region:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
943
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
944
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
945
|
+
<span class='label'>http_endpoint_configuration_id:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
946
|
+
<span class='label'>https_endpoint_configuration_id:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
947
|
+
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
948
|
+
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span>
|
|
949
|
+
<span class='rparen'>)</span>
|
|
950
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
951
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
|
952
|
+
<span class='label'>region:</span> <span class='id identifier rubyid_region'>region</span><span class='comma'>,</span>
|
|
953
|
+
<span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
|
|
954
|
+
<span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
|
|
955
|
+
<span class='label'>http_endpoint_configuration_id:</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span><span class='comma'>,</span>
|
|
956
|
+
<span class='label'>https_endpoint_configuration_id:</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span><span class='comma'>,</span>
|
|
957
|
+
<span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
|
|
958
|
+
<span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span><span class='comma'>,</span>
|
|
959
|
+
<span class='rbrace'>}</span>
|
|
960
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
961
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
962
|
+
<span class='kw'>end</span></pre>
|
|
963
|
+
</td>
|
|
964
|
+
</tr>
|
|
965
|
+
</table>
|
|
966
|
+
</div>
|
|
967
|
+
|
|
968
|
+
<div class="method_details ">
|
|
969
|
+
<h3 class="signature " id="delete-instance_method">
|
|
970
|
+
|
|
971
|
+
#<strong>delete</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
</h3><div class="docstring">
|
|
978
|
+
<div class="discussion">
|
|
979
|
+
|
|
980
|
+
<p>Delete a reserved domain.</p>
|
|
981
|
+
|
|
982
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-delete</a></p>
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
</div>
|
|
986
|
+
</div>
|
|
987
|
+
<div class="tags">
|
|
988
|
+
<p class="tag_title">Parameters:</p>
|
|
989
|
+
<ul class="param">
|
|
990
|
+
|
|
991
|
+
<li>
|
|
992
|
+
|
|
993
|
+
<span class='name'>id</span>
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
—
|
|
1003
|
+
<div class='inline'>
|
|
1004
|
+
<p>a resource identifier</p>
|
|
1005
|
+
</div>
|
|
1006
|
+
|
|
1007
|
+
</li>
|
|
1008
|
+
|
|
1009
|
+
</ul>
|
|
1010
|
+
|
|
1011
|
+
<p class="tag_title">Returns:</p>
|
|
1012
|
+
<ul class="return">
|
|
1013
|
+
|
|
1014
|
+
<li>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
—
|
|
1022
|
+
<div class='inline'>
|
|
1023
|
+
<p>result from delete request</p>
|
|
1024
|
+
</div>
|
|
1025
|
+
|
|
1026
|
+
</li>
|
|
1027
|
+
|
|
1028
|
+
</ul>
|
|
1029
|
+
|
|
1030
|
+
</div><table class="source_code">
|
|
1031
|
+
<tr>
|
|
1032
|
+
<td>
|
|
1033
|
+
<pre class="lines">
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
69
|
|
1037
|
+
70
|
|
1038
|
+
71</pre>
|
|
1039
|
+
</td>
|
|
1040
|
+
<td>
|
|
1041
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 69</span>
|
|
1042
|
+
|
|
1043
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1044
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1045
|
+
<span class='kw'>end</span></pre>
|
|
1046
|
+
</td>
|
|
1047
|
+
</tr>
|
|
1048
|
+
</table>
|
|
1049
|
+
</div>
|
|
1050
|
+
|
|
1051
|
+
<div class="method_details ">
|
|
1052
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
1053
|
+
|
|
1054
|
+
#<strong>delete!</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
</h3><div class="docstring">
|
|
1061
|
+
<div class="discussion">
|
|
1062
|
+
|
|
1063
|
+
<p>Delete a reserved domain. Throw an exception if 404.</p>
|
|
1064
|
+
|
|
1065
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-delete</a></p>
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
</div>
|
|
1069
|
+
</div>
|
|
1070
|
+
<div class="tags">
|
|
1071
|
+
<p class="tag_title">Parameters:</p>
|
|
1072
|
+
<ul class="param">
|
|
1073
|
+
|
|
1074
|
+
<li>
|
|
1075
|
+
|
|
1076
|
+
<span class='name'>id</span>
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
—
|
|
1086
|
+
<div class='inline'>
|
|
1087
|
+
<p>a resource identifier</p>
|
|
1088
|
+
</div>
|
|
1089
|
+
|
|
1090
|
+
</li>
|
|
1091
|
+
|
|
1092
|
+
</ul>
|
|
1093
|
+
|
|
1094
|
+
<p class="tag_title">Returns:</p>
|
|
1095
|
+
<ul class="return">
|
|
1096
|
+
|
|
1097
|
+
<li>
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
—
|
|
1105
|
+
<div class='inline'>
|
|
1106
|
+
<p>result from delete request</p>
|
|
1107
|
+
</div>
|
|
1108
|
+
|
|
1109
|
+
</li>
|
|
1110
|
+
|
|
1111
|
+
</ul>
|
|
1112
|
+
|
|
1113
|
+
</div><table class="source_code">
|
|
1114
|
+
<tr>
|
|
1115
|
+
<td>
|
|
1116
|
+
<pre class="lines">
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
80
|
|
1120
|
+
81
|
|
1121
|
+
82</pre>
|
|
1122
|
+
</td>
|
|
1123
|
+
<td>
|
|
1124
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 80</span>
|
|
1125
|
+
|
|
1126
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1127
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1128
|
+
<span class='kw'>end</span></pre>
|
|
1129
|
+
</td>
|
|
1130
|
+
</tr>
|
|
1131
|
+
</table>
|
|
1132
|
+
</div>
|
|
1133
|
+
|
|
1134
|
+
<div class="method_details ">
|
|
1135
|
+
<h3 class="signature " id="delete_certificate-instance_method">
|
|
1136
|
+
|
|
1137
|
+
#<strong>delete_certificate</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
</h3><div class="docstring">
|
|
1144
|
+
<div class="discussion">
|
|
1145
|
+
|
|
1146
|
+
<p>Detach the certificate attached from a reserved domain.</p>
|
|
1147
|
+
|
|
1148
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
</div>
|
|
1152
|
+
</div>
|
|
1153
|
+
<div class="tags">
|
|
1154
|
+
<p class="tag_title">Parameters:</p>
|
|
1155
|
+
<ul class="param">
|
|
1156
|
+
|
|
1157
|
+
<li>
|
|
1158
|
+
|
|
1159
|
+
<span class='name'>id</span>
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
—
|
|
1169
|
+
<div class='inline'>
|
|
1170
|
+
<p>a resource identifier</p>
|
|
1171
|
+
</div>
|
|
1172
|
+
|
|
1173
|
+
</li>
|
|
1174
|
+
|
|
1175
|
+
</ul>
|
|
1176
|
+
|
|
1177
|
+
<p class="tag_title">Returns:</p>
|
|
1178
|
+
<ul class="return">
|
|
1179
|
+
|
|
1180
|
+
<li>
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
—
|
|
1188
|
+
<div class='inline'>
|
|
1189
|
+
<p>result from delete request</p>
|
|
1190
|
+
</div>
|
|
1191
|
+
|
|
1192
|
+
</li>
|
|
1193
|
+
|
|
1194
|
+
</ul>
|
|
1195
|
+
|
|
1196
|
+
</div><table class="source_code">
|
|
1197
|
+
<tr>
|
|
1198
|
+
<td>
|
|
1199
|
+
<pre class="lines">
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
205
|
|
1203
|
+
206
|
|
1204
|
+
207</pre>
|
|
1205
|
+
</td>
|
|
1206
|
+
<td>
|
|
1207
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 205</span>
|
|
1208
|
+
|
|
1209
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1210
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/certificate</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1211
|
+
<span class='kw'>end</span></pre>
|
|
1212
|
+
</td>
|
|
1213
|
+
</tr>
|
|
1214
|
+
</table>
|
|
1215
|
+
</div>
|
|
1216
|
+
|
|
1217
|
+
<div class="method_details ">
|
|
1218
|
+
<h3 class="signature " id="delete_certificate!-instance_method">
|
|
1219
|
+
|
|
1220
|
+
#<strong>delete_certificate!</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
</h3><div class="docstring">
|
|
1227
|
+
<div class="discussion">
|
|
1228
|
+
|
|
1229
|
+
<p>Detach the certificate attached from a reserved domain. Throw an exception if 404.</p>
|
|
1230
|
+
|
|
1231
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
</div>
|
|
1235
|
+
</div>
|
|
1236
|
+
<div class="tags">
|
|
1237
|
+
<p class="tag_title">Parameters:</p>
|
|
1238
|
+
<ul class="param">
|
|
1239
|
+
|
|
1240
|
+
<li>
|
|
1241
|
+
|
|
1242
|
+
<span class='name'>id</span>
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
—
|
|
1252
|
+
<div class='inline'>
|
|
1253
|
+
<p>a resource identifier</p>
|
|
1254
|
+
</div>
|
|
1255
|
+
|
|
1256
|
+
</li>
|
|
1257
|
+
|
|
1258
|
+
</ul>
|
|
1259
|
+
|
|
1260
|
+
<p class="tag_title">Returns:</p>
|
|
1261
|
+
<ul class="return">
|
|
1262
|
+
|
|
1263
|
+
<li>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
—
|
|
1271
|
+
<div class='inline'>
|
|
1272
|
+
<p>result from delete request</p>
|
|
1273
|
+
</div>
|
|
1274
|
+
|
|
1275
|
+
</li>
|
|
1276
|
+
|
|
1277
|
+
</ul>
|
|
1278
|
+
|
|
1279
|
+
</div><table class="source_code">
|
|
1280
|
+
<tr>
|
|
1281
|
+
<td>
|
|
1282
|
+
<pre class="lines">
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
216
|
|
1286
|
+
217
|
|
1287
|
+
218</pre>
|
|
1288
|
+
</td>
|
|
1289
|
+
<td>
|
|
1290
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 216</span>
|
|
1291
|
+
|
|
1292
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate!'>delete_certificate!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1293
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/certificate</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1294
|
+
<span class='kw'>end</span></pre>
|
|
1295
|
+
</td>
|
|
1296
|
+
</tr>
|
|
1297
|
+
</table>
|
|
1298
|
+
</div>
|
|
1299
|
+
|
|
1300
|
+
<div class="method_details ">
|
|
1301
|
+
<h3 class="signature " id="delete_certificate_management_policy-instance_method">
|
|
1302
|
+
|
|
1303
|
+
#<strong>delete_certificate_management_policy</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
</h3><div class="docstring">
|
|
1310
|
+
<div class="discussion">
|
|
1311
|
+
|
|
1312
|
+
<p>Detach the certificate management policy attached from a reserved domain.</p>
|
|
1313
|
+
|
|
1314
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy">ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</a></p>
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
</div>
|
|
1318
|
+
</div>
|
|
1319
|
+
<div class="tags">
|
|
1320
|
+
<p class="tag_title">Parameters:</p>
|
|
1321
|
+
<ul class="param">
|
|
1322
|
+
|
|
1323
|
+
<li>
|
|
1324
|
+
|
|
1325
|
+
<span class='name'>id</span>
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
—
|
|
1335
|
+
<div class='inline'>
|
|
1336
|
+
<p>a resource identifier</p>
|
|
1337
|
+
</div>
|
|
1338
|
+
|
|
1339
|
+
</li>
|
|
1340
|
+
|
|
1341
|
+
</ul>
|
|
1342
|
+
|
|
1343
|
+
<p class="tag_title">Returns:</p>
|
|
1344
|
+
<ul class="return">
|
|
1345
|
+
|
|
1346
|
+
<li>
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
—
|
|
1354
|
+
<div class='inline'>
|
|
1355
|
+
<p>result from delete request</p>
|
|
1356
|
+
</div>
|
|
1357
|
+
|
|
1358
|
+
</li>
|
|
1359
|
+
|
|
1360
|
+
</ul>
|
|
1361
|
+
|
|
1362
|
+
</div><table class="source_code">
|
|
1363
|
+
<tr>
|
|
1364
|
+
<td>
|
|
1365
|
+
<pre class="lines">
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
227
|
|
1369
|
+
228
|
|
1370
|
+
229</pre>
|
|
1371
|
+
</td>
|
|
1372
|
+
<td>
|
|
1373
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 227</span>
|
|
1374
|
+
|
|
1375
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1376
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/certificate_management_policy</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1377
|
+
<span class='kw'>end</span></pre>
|
|
1378
|
+
</td>
|
|
1379
|
+
</tr>
|
|
1380
|
+
</table>
|
|
1381
|
+
</div>
|
|
1382
|
+
|
|
1383
|
+
<div class="method_details ">
|
|
1384
|
+
<h3 class="signature " id="delete_certificate_management_policy!-instance_method">
|
|
1385
|
+
|
|
1386
|
+
#<strong>delete_certificate_management_policy!</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
</h3><div class="docstring">
|
|
1393
|
+
<div class="discussion">
|
|
1394
|
+
|
|
1395
|
+
<p>Detach the certificate management policy attached from a reserved domain.</p>
|
|
1396
|
+
|
|
1397
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy">ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</a></p>
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
</div>
|
|
1401
|
+
</div>
|
|
1402
|
+
<div class="tags">
|
|
1403
|
+
<p class="tag_title">Parameters:</p>
|
|
1404
|
+
<ul class="param">
|
|
1405
|
+
|
|
1406
|
+
<li>
|
|
1407
|
+
|
|
1408
|
+
<span class='name'>id</span>
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
—
|
|
1418
|
+
<div class='inline'>
|
|
1419
|
+
<p>a resource identifier</p>
|
|
1420
|
+
</div>
|
|
1421
|
+
|
|
1422
|
+
</li>
|
|
1423
|
+
|
|
1424
|
+
</ul>
|
|
1425
|
+
|
|
1426
|
+
<p class="tag_title">Returns:</p>
|
|
1427
|
+
<ul class="return">
|
|
1428
|
+
|
|
1429
|
+
<li>
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
—
|
|
1437
|
+
<div class='inline'>
|
|
1438
|
+
<p>result from delete request</p>
|
|
1439
|
+
</div>
|
|
1440
|
+
|
|
1441
|
+
</li>
|
|
1442
|
+
|
|
1443
|
+
</ul>
|
|
1444
|
+
|
|
1445
|
+
</div><table class="source_code">
|
|
1446
|
+
<tr>
|
|
1447
|
+
<td>
|
|
1448
|
+
<pre class="lines">
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
238
|
|
1452
|
+
239
|
|
1453
|
+
240</pre>
|
|
1454
|
+
</td>
|
|
1455
|
+
<td>
|
|
1456
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 238</span>
|
|
1457
|
+
|
|
1458
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy!'>delete_certificate_management_policy!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1459
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/certificate_management_policy</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1460
|
+
<span class='kw'>end</span></pre>
|
|
1461
|
+
</td>
|
|
1462
|
+
</tr>
|
|
1463
|
+
</table>
|
|
1464
|
+
</div>
|
|
1465
|
+
|
|
1466
|
+
<div class="method_details ">
|
|
1467
|
+
<h3 class="signature " id="delete_http_endpoint_config-instance_method">
|
|
1468
|
+
|
|
1469
|
+
#<strong>delete_http_endpoint_config</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
</h3><div class="docstring">
|
|
1476
|
+
<div class="discussion">
|
|
1477
|
+
|
|
1478
|
+
<p>Detach the http endpoint configuration attached from a reserved domain.</p>
|
|
1479
|
+
|
|
1480
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config</a></p>
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
</div>
|
|
1484
|
+
</div>
|
|
1485
|
+
<div class="tags">
|
|
1486
|
+
<p class="tag_title">Parameters:</p>
|
|
1487
|
+
<ul class="param">
|
|
1488
|
+
|
|
1489
|
+
<li>
|
|
1490
|
+
|
|
1491
|
+
<span class='name'>id</span>
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
—
|
|
1501
|
+
<div class='inline'>
|
|
1502
|
+
<p>a resource identifier</p>
|
|
1503
|
+
</div>
|
|
1504
|
+
|
|
1505
|
+
</li>
|
|
1506
|
+
|
|
1507
|
+
</ul>
|
|
1508
|
+
|
|
1509
|
+
<p class="tag_title">Returns:</p>
|
|
1510
|
+
<ul class="return">
|
|
1511
|
+
|
|
1512
|
+
<li>
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
—
|
|
1520
|
+
<div class='inline'>
|
|
1521
|
+
<p>result from delete request</p>
|
|
1522
|
+
</div>
|
|
1523
|
+
|
|
1524
|
+
</li>
|
|
1525
|
+
|
|
1526
|
+
</ul>
|
|
1527
|
+
|
|
1528
|
+
</div><table class="source_code">
|
|
1529
|
+
<tr>
|
|
1530
|
+
<td>
|
|
1531
|
+
<pre class="lines">
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
249
|
|
1535
|
+
250
|
|
1536
|
+
251</pre>
|
|
1537
|
+
</td>
|
|
1538
|
+
<td>
|
|
1539
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 249</span>
|
|
1540
|
+
|
|
1541
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1542
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/http_endpoint_configuration</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1543
|
+
<span class='kw'>end</span></pre>
|
|
1544
|
+
</td>
|
|
1545
|
+
</tr>
|
|
1546
|
+
</table>
|
|
1547
|
+
</div>
|
|
1548
|
+
|
|
1549
|
+
<div class="method_details ">
|
|
1550
|
+
<h3 class="signature " id="delete_http_endpoint_config!-instance_method">
|
|
1551
|
+
|
|
1552
|
+
#<strong>delete_http_endpoint_config!</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
|
|
1558
|
+
</h3><div class="docstring">
|
|
1559
|
+
<div class="discussion">
|
|
1560
|
+
|
|
1561
|
+
<p>Detach the http endpoint configuration attached from a reserved domain. Throw an exception if 404.</p>
|
|
1562
|
+
|
|
1563
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config</a></p>
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
</div>
|
|
1567
|
+
</div>
|
|
1568
|
+
<div class="tags">
|
|
1569
|
+
<p class="tag_title">Parameters:</p>
|
|
1570
|
+
<ul class="param">
|
|
1571
|
+
|
|
1572
|
+
<li>
|
|
1573
|
+
|
|
1574
|
+
<span class='name'>id</span>
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
—
|
|
1584
|
+
<div class='inline'>
|
|
1585
|
+
<p>a resource identifier</p>
|
|
1586
|
+
</div>
|
|
1587
|
+
|
|
1588
|
+
</li>
|
|
1589
|
+
|
|
1590
|
+
</ul>
|
|
1591
|
+
|
|
1592
|
+
<p class="tag_title">Returns:</p>
|
|
1593
|
+
<ul class="return">
|
|
1594
|
+
|
|
1595
|
+
<li>
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
—
|
|
1603
|
+
<div class='inline'>
|
|
1604
|
+
<p>result from delete request</p>
|
|
1605
|
+
</div>
|
|
1606
|
+
|
|
1607
|
+
</li>
|
|
1608
|
+
|
|
1609
|
+
</ul>
|
|
1610
|
+
|
|
1611
|
+
</div><table class="source_code">
|
|
1612
|
+
<tr>
|
|
1613
|
+
<td>
|
|
1614
|
+
<pre class="lines">
|
|
1615
|
+
|
|
1616
|
+
|
|
1617
|
+
260
|
|
1618
|
+
261
|
|
1619
|
+
262</pre>
|
|
1620
|
+
</td>
|
|
1621
|
+
<td>
|
|
1622
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 260</span>
|
|
1623
|
+
|
|
1624
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config!'>delete_http_endpoint_config!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1625
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/http_endpoint_configuration</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1626
|
+
<span class='kw'>end</span></pre>
|
|
1627
|
+
</td>
|
|
1628
|
+
</tr>
|
|
1629
|
+
</table>
|
|
1630
|
+
</div>
|
|
1631
|
+
|
|
1632
|
+
<div class="method_details ">
|
|
1633
|
+
<h3 class="signature " id="delete_https_endpoint_config-instance_method">
|
|
1634
|
+
|
|
1635
|
+
#<strong>delete_https_endpoint_config</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
</h3><div class="docstring">
|
|
1642
|
+
<div class="discussion">
|
|
1643
|
+
|
|
1644
|
+
<p>Detach the https endpoint configuration attached from a reserved domain.</p>
|
|
1645
|
+
|
|
1646
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config</a></p>
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
</div>
|
|
1650
|
+
</div>
|
|
1651
|
+
<div class="tags">
|
|
1652
|
+
<p class="tag_title">Parameters:</p>
|
|
1653
|
+
<ul class="param">
|
|
1654
|
+
|
|
1655
|
+
<li>
|
|
1656
|
+
|
|
1657
|
+
<span class='name'>id</span>
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
—
|
|
1667
|
+
<div class='inline'>
|
|
1668
|
+
<p>a resource identifier</p>
|
|
1669
|
+
</div>
|
|
1670
|
+
|
|
1671
|
+
</li>
|
|
1672
|
+
|
|
1673
|
+
</ul>
|
|
1674
|
+
|
|
1675
|
+
<p class="tag_title">Returns:</p>
|
|
1676
|
+
<ul class="return">
|
|
1677
|
+
|
|
1678
|
+
<li>
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
—
|
|
1686
|
+
<div class='inline'>
|
|
1687
|
+
<p>result from delete request</p>
|
|
1688
|
+
</div>
|
|
1689
|
+
|
|
1690
|
+
</li>
|
|
1691
|
+
|
|
1692
|
+
</ul>
|
|
1693
|
+
|
|
1694
|
+
</div><table class="source_code">
|
|
1695
|
+
<tr>
|
|
1696
|
+
<td>
|
|
1697
|
+
<pre class="lines">
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
271
|
|
1701
|
+
272
|
|
1702
|
+
273</pre>
|
|
1703
|
+
</td>
|
|
1704
|
+
<td>
|
|
1705
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 271</span>
|
|
1706
|
+
|
|
1707
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1708
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/https_endpoint_configuration</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1709
|
+
<span class='kw'>end</span></pre>
|
|
1710
|
+
</td>
|
|
1711
|
+
</tr>
|
|
1712
|
+
</table>
|
|
1713
|
+
</div>
|
|
1714
|
+
|
|
1715
|
+
<div class="method_details ">
|
|
1716
|
+
<h3 class="signature " id="delete_https_endpoint_config!-instance_method">
|
|
1717
|
+
|
|
1718
|
+
#<strong>delete_https_endpoint_config!</strong>(id: nil) ⇒ <tt>nil</tt>
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
</h3><div class="docstring">
|
|
1725
|
+
<div class="discussion">
|
|
1726
|
+
|
|
1727
|
+
<p>Detach the https endpoint configuration attached from a reserved domain. Throw an exception if 404.</p>
|
|
1728
|
+
|
|
1729
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config</a></p>
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
</div>
|
|
1733
|
+
</div>
|
|
1734
|
+
<div class="tags">
|
|
1735
|
+
<p class="tag_title">Parameters:</p>
|
|
1736
|
+
<ul class="param">
|
|
1737
|
+
|
|
1738
|
+
<li>
|
|
1739
|
+
|
|
1740
|
+
<span class='name'>id</span>
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
—
|
|
1750
|
+
<div class='inline'>
|
|
1751
|
+
<p>a resource identifier</p>
|
|
1752
|
+
</div>
|
|
1753
|
+
|
|
1754
|
+
</li>
|
|
1755
|
+
|
|
1756
|
+
</ul>
|
|
1757
|
+
|
|
1758
|
+
<p class="tag_title">Returns:</p>
|
|
1759
|
+
<ul class="return">
|
|
1760
|
+
|
|
1761
|
+
<li>
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
—
|
|
1769
|
+
<div class='inline'>
|
|
1770
|
+
<p>result from delete request</p>
|
|
1771
|
+
</div>
|
|
1772
|
+
|
|
1773
|
+
</li>
|
|
1774
|
+
|
|
1775
|
+
</ul>
|
|
1776
|
+
|
|
1777
|
+
</div><table class="source_code">
|
|
1778
|
+
<tr>
|
|
1779
|
+
<td>
|
|
1780
|
+
<pre class="lines">
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
282
|
|
1784
|
+
283
|
|
1785
|
+
284</pre>
|
|
1786
|
+
</td>
|
|
1787
|
+
<td>
|
|
1788
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 282</span>
|
|
1789
|
+
|
|
1790
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config!'>delete_https_endpoint_config!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1791
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/https_endpoint_configuration</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1792
|
+
<span class='kw'>end</span></pre>
|
|
1793
|
+
</td>
|
|
1794
|
+
</tr>
|
|
1795
|
+
</table>
|
|
1796
|
+
</div>
|
|
1797
|
+
|
|
1798
|
+
<div class="method_details ">
|
|
1799
|
+
<h3 class="signature " id="get-instance_method">
|
|
1800
|
+
|
|
1801
|
+
#<strong>get</strong>(id: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
|
|
1807
|
+
</h3><div class="docstring">
|
|
1808
|
+
<div class="discussion">
|
|
1809
|
+
|
|
1810
|
+
<p>Get the details of a reserved domain.</p>
|
|
1811
|
+
|
|
1812
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-get">ngrok.com/docs/api#api-reserved-domains-get</a></p>
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
</div>
|
|
1816
|
+
</div>
|
|
1817
|
+
<div class="tags">
|
|
1818
|
+
<p class="tag_title">Parameters:</p>
|
|
1819
|
+
<ul class="param">
|
|
1820
|
+
|
|
1821
|
+
<li>
|
|
1822
|
+
|
|
1823
|
+
<span class='name'>id</span>
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
—
|
|
1833
|
+
<div class='inline'>
|
|
1834
|
+
<p>a resource identifier</p>
|
|
1835
|
+
</div>
|
|
1836
|
+
|
|
1837
|
+
</li>
|
|
1838
|
+
|
|
1839
|
+
</ul>
|
|
1840
|
+
|
|
1841
|
+
<p class="tag_title">Returns:</p>
|
|
1842
|
+
<ul class="return">
|
|
1843
|
+
|
|
1844
|
+
<li>
|
|
1845
|
+
|
|
1846
|
+
|
|
1847
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
—
|
|
1852
|
+
<div class='inline'>
|
|
1853
|
+
<p>result from get request</p>
|
|
1854
|
+
</div>
|
|
1855
|
+
|
|
1856
|
+
</li>
|
|
1857
|
+
|
|
1858
|
+
</ul>
|
|
1859
|
+
|
|
1860
|
+
</div><table class="source_code">
|
|
1861
|
+
<tr>
|
|
1862
|
+
<td>
|
|
1863
|
+
<pre class="lines">
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
91
|
|
1867
|
+
92
|
|
1868
|
+
93
|
|
1869
|
+
94</pre>
|
|
1870
|
+
</td>
|
|
1871
|
+
<td>
|
|
1872
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 91</span>
|
|
1873
|
+
|
|
1874
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1875
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1876
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1877
|
+
<span class='kw'>end</span></pre>
|
|
1878
|
+
</td>
|
|
1879
|
+
</tr>
|
|
1880
|
+
</table>
|
|
1881
|
+
</div>
|
|
1882
|
+
|
|
1883
|
+
<div class="method_details ">
|
|
1884
|
+
<h3 class="signature " id="get!-instance_method">
|
|
1885
|
+
|
|
1886
|
+
#<strong>get!</strong>(id: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
</h3><div class="docstring">
|
|
1893
|
+
<div class="discussion">
|
|
1894
|
+
|
|
1895
|
+
<p>Get the details of a reserved domain. Throw an exception if 404.</p>
|
|
1896
|
+
|
|
1897
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-get">ngrok.com/docs/api#api-reserved-domains-get</a></p>
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
</div>
|
|
1901
|
+
</div>
|
|
1902
|
+
<div class="tags">
|
|
1903
|
+
<p class="tag_title">Parameters:</p>
|
|
1904
|
+
<ul class="param">
|
|
1905
|
+
|
|
1906
|
+
<li>
|
|
1907
|
+
|
|
1908
|
+
<span class='name'>id</span>
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
—
|
|
1918
|
+
<div class='inline'>
|
|
1919
|
+
<p>a resource identifier</p>
|
|
1920
|
+
</div>
|
|
1921
|
+
|
|
1922
|
+
</li>
|
|
1923
|
+
|
|
1924
|
+
</ul>
|
|
1925
|
+
|
|
1926
|
+
<p class="tag_title">Returns:</p>
|
|
1927
|
+
<ul class="return">
|
|
1928
|
+
|
|
1929
|
+
<li>
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
|
|
1936
|
+
—
|
|
1937
|
+
<div class='inline'>
|
|
1938
|
+
<p>result from get request</p>
|
|
1939
|
+
</div>
|
|
1940
|
+
|
|
1941
|
+
</li>
|
|
1942
|
+
|
|
1943
|
+
</ul>
|
|
1944
|
+
|
|
1945
|
+
</div><table class="source_code">
|
|
1946
|
+
<tr>
|
|
1947
|
+
<td>
|
|
1948
|
+
<pre class="lines">
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
103
|
|
1952
|
+
104
|
|
1953
|
+
105
|
|
1954
|
+
106</pre>
|
|
1955
|
+
</td>
|
|
1956
|
+
<td>
|
|
1957
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 103</span>
|
|
1958
|
+
|
|
1959
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1960
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1961
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1962
|
+
<span class='kw'>end</span></pre>
|
|
1963
|
+
</td>
|
|
1964
|
+
</tr>
|
|
1965
|
+
</table>
|
|
1966
|
+
</div>
|
|
1967
|
+
|
|
1968
|
+
<div class="method_details ">
|
|
1969
|
+
<h3 class="signature " id="list-instance_method">
|
|
1970
|
+
|
|
1971
|
+
#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1972
|
+
|
|
1973
|
+
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
</h3><div class="docstring">
|
|
1978
|
+
<div class="discussion">
|
|
1979
|
+
|
|
1980
|
+
<p>List all reserved domains on this account.</p>
|
|
1981
|
+
|
|
1982
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-list">ngrok.com/docs/api#api-reserved-domains-list</a></p>
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
</div>
|
|
1986
|
+
</div>
|
|
1987
|
+
<div class="tags">
|
|
1988
|
+
<p class="tag_title">Parameters:</p>
|
|
1989
|
+
<ul class="param">
|
|
1990
|
+
|
|
1991
|
+
<li>
|
|
1992
|
+
|
|
1993
|
+
<span class='name'>before_id</span>
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2000
|
+
|
|
2001
|
+
|
|
2002
|
+
</li>
|
|
2003
|
+
|
|
2004
|
+
<li>
|
|
2005
|
+
|
|
2006
|
+
<span class='name'>limit</span>
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
<span class='type'>(<tt>integer</tt>)</span>
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
</li>
|
|
2016
|
+
|
|
2017
|
+
<li>
|
|
2018
|
+
|
|
2019
|
+
<span class='name'>url</span>
|
|
2020
|
+
|
|
2021
|
+
|
|
2022
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2023
|
+
|
|
2024
|
+
|
|
2025
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2026
|
+
|
|
2027
|
+
|
|
2028
|
+
—
|
|
2029
|
+
<div class='inline'>
|
|
2030
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
2031
|
+
</div>
|
|
2032
|
+
|
|
2033
|
+
</li>
|
|
2034
|
+
|
|
2035
|
+
</ul>
|
|
2036
|
+
|
|
2037
|
+
<p class="tag_title">Returns:</p>
|
|
2038
|
+
<ul class="return">
|
|
2039
|
+
|
|
2040
|
+
<li>
|
|
2041
|
+
|
|
2042
|
+
|
|
2043
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
2044
|
+
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
—
|
|
2048
|
+
<div class='inline'>
|
|
2049
|
+
<p>result from list request</p>
|
|
2050
|
+
</div>
|
|
2051
|
+
|
|
2052
|
+
</li>
|
|
2053
|
+
|
|
2054
|
+
</ul>
|
|
2055
|
+
|
|
2056
|
+
</div><table class="source_code">
|
|
2057
|
+
<tr>
|
|
2058
|
+
<td>
|
|
2059
|
+
<pre class="lines">
|
|
2060
|
+
|
|
2061
|
+
|
|
2062
|
+
117
|
|
2063
|
+
118
|
|
2064
|
+
119
|
|
2065
|
+
120
|
|
2066
|
+
121
|
|
2067
|
+
122
|
|
2068
|
+
123
|
|
2069
|
+
124
|
|
2070
|
+
125</pre>
|
|
2071
|
+
</td>
|
|
2072
|
+
<td>
|
|
2073
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 117</span>
|
|
2074
|
+
|
|
2075
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
2076
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='rparen'>)</span>
|
|
2077
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
2078
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
2079
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
2080
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedDomainsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
2081
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span>
|
|
2082
|
+
<span class='rparen'>)</span>
|
|
2083
|
+
<span class='kw'>end</span></pre>
|
|
2084
|
+
</td>
|
|
2085
|
+
</tr>
|
|
2086
|
+
</table>
|
|
2087
|
+
</div>
|
|
2088
|
+
|
|
2089
|
+
<div class="method_details ">
|
|
2090
|
+
<h3 class="signature " id="update-instance_method">
|
|
2091
|
+
|
|
2092
|
+
#<strong>update</strong>(id: nil, certificate_id: nil, certificate_management_policy: nil, description: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
|
2093
|
+
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
|
|
2097
|
+
|
|
2098
|
+
</h3><div class="docstring">
|
|
2099
|
+
<div class="discussion">
|
|
2100
|
+
|
|
2101
|
+
<p>Update the attributes of a reserved domain.</p>
|
|
2102
|
+
|
|
2103
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-update</a></p>
|
|
2104
|
+
|
|
2105
|
+
|
|
2106
|
+
</div>
|
|
2107
|
+
</div>
|
|
2108
|
+
<div class="tags">
|
|
2109
|
+
<p class="tag_title">Parameters:</p>
|
|
2110
|
+
<ul class="param">
|
|
2111
|
+
|
|
2112
|
+
<li>
|
|
2113
|
+
|
|
2114
|
+
<span class='name'>id</span>
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
</li>
|
|
2124
|
+
|
|
2125
|
+
<li>
|
|
2126
|
+
|
|
2127
|
+
<span class='name'>description</span>
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2131
|
+
|
|
2132
|
+
|
|
2133
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2134
|
+
|
|
2135
|
+
|
|
2136
|
+
—
|
|
2137
|
+
<div class='inline'>
|
|
2138
|
+
<p>human-readable description of what this reserved domain will be used for</p>
|
|
2139
|
+
</div>
|
|
2140
|
+
|
|
2141
|
+
</li>
|
|
2142
|
+
|
|
2143
|
+
<li>
|
|
2144
|
+
|
|
2145
|
+
<span class='name'>metadata</span>
|
|
2146
|
+
|
|
2147
|
+
|
|
2148
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2149
|
+
|
|
2150
|
+
|
|
2151
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
—
|
|
2155
|
+
<div class='inline'>
|
|
2156
|
+
<p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
|
|
2157
|
+
</div>
|
|
2158
|
+
|
|
2159
|
+
</li>
|
|
2160
|
+
|
|
2161
|
+
<li>
|
|
2162
|
+
|
|
2163
|
+
<span class='name'>http_endpoint_configuration_id</span>
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2167
|
+
|
|
2168
|
+
|
|
2169
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2170
|
+
|
|
2171
|
+
|
|
2172
|
+
—
|
|
2173
|
+
<div class='inline'>
|
|
2174
|
+
<p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
|
|
2175
|
+
</div>
|
|
2176
|
+
|
|
2177
|
+
</li>
|
|
2178
|
+
|
|
2179
|
+
<li>
|
|
2180
|
+
|
|
2181
|
+
<span class='name'>https_endpoint_configuration_id</span>
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
—
|
|
2191
|
+
<div class='inline'>
|
|
2192
|
+
<p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
|
|
2193
|
+
</div>
|
|
2194
|
+
|
|
2195
|
+
</li>
|
|
2196
|
+
|
|
2197
|
+
<li>
|
|
2198
|
+
|
|
2199
|
+
<span class='name'>certificate_id</span>
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
—
|
|
2209
|
+
<div class='inline'>
|
|
2210
|
+
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
|
|
2211
|
+
</div>
|
|
2212
|
+
|
|
2213
|
+
</li>
|
|
2214
|
+
|
|
2215
|
+
<li>
|
|
2216
|
+
|
|
2217
|
+
<span class='name'>certificate_management_policy</span>
|
|
2218
|
+
|
|
2219
|
+
|
|
2220
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2221
|
+
|
|
2222
|
+
|
|
2223
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2224
|
+
|
|
2225
|
+
|
|
2226
|
+
—
|
|
2227
|
+
<div class='inline'>
|
|
2228
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p>
|
|
2229
|
+
</div>
|
|
2230
|
+
|
|
2231
|
+
</li>
|
|
2232
|
+
|
|
2233
|
+
</ul>
|
|
2234
|
+
|
|
2235
|
+
<p class="tag_title">Returns:</p>
|
|
2236
|
+
<ul class="return">
|
|
2237
|
+
|
|
2238
|
+
<li>
|
|
2239
|
+
|
|
2240
|
+
|
|
2241
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
|
|
2242
|
+
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
—
|
|
2246
|
+
<div class='inline'>
|
|
2247
|
+
<p>result from update request</p>
|
|
2248
|
+
</div>
|
|
2249
|
+
|
|
2250
|
+
</li>
|
|
2251
|
+
|
|
2252
|
+
</ul>
|
|
2253
|
+
|
|
2254
|
+
</div><table class="source_code">
|
|
2255
|
+
<tr>
|
|
2256
|
+
<td>
|
|
2257
|
+
<pre class="lines">
|
|
2258
|
+
|
|
2259
|
+
|
|
2260
|
+
142
|
|
2261
|
+
143
|
|
2262
|
+
144
|
|
2263
|
+
145
|
|
2264
|
+
146
|
|
2265
|
+
147
|
|
2266
|
+
148
|
|
2267
|
+
149
|
|
2268
|
+
150
|
|
2269
|
+
151
|
|
2270
|
+
152
|
|
2271
|
+
153
|
|
2272
|
+
154
|
|
2273
|
+
155
|
|
2274
|
+
156
|
|
2275
|
+
157
|
|
2276
|
+
158
|
|
2277
|
+
159
|
|
2278
|
+
160
|
|
2279
|
+
161</pre>
|
|
2280
|
+
</td>
|
|
2281
|
+
<td>
|
|
2282
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 142</span>
|
|
2283
|
+
|
|
2284
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
2285
|
+
<span class='label'>id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2286
|
+
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2287
|
+
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2288
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2289
|
+
<span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2290
|
+
<span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2291
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
2292
|
+
<span class='rparen'>)</span>
|
|
2293
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</span>
|
|
2294
|
+
<span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
|
|
2295
|
+
<span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
|
|
2296
|
+
<span class='label'>http_endpoint_configuration_id:</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span><span class='comma'>,</span>
|
|
2297
|
+
<span class='label'>https_endpoint_configuration_id:</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span><span class='comma'>,</span>
|
|
2298
|
+
<span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
|
|
2299
|
+
<span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
|
2300
|
+
<span class='rparen'>)</span>
|
|
2301
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
2302
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
2303
|
+
<span class='kw'>end</span></pre>
|
|
2304
|
+
</td>
|
|
2305
|
+
</tr>
|
|
2306
|
+
</table>
|
|
2307
|
+
</div>
|
|
2308
|
+
|
|
2309
|
+
<div class="method_details ">
|
|
2310
|
+
<h3 class="signature " id="update!-instance_method">
|
|
2311
|
+
|
|
2312
|
+
#<strong>update!</strong>(id: nil, certificate_id: nil, certificate_management_policy: nil, description: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
</h3><div class="docstring">
|
|
2319
|
+
<div class="discussion">
|
|
2320
|
+
|
|
2321
|
+
<p>Update the attributes of a reserved domain. Throw an exception if 404.</p>
|
|
2322
|
+
|
|
2323
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-update</a></p>
|
|
2324
|
+
|
|
2325
|
+
|
|
2326
|
+
</div>
|
|
2327
|
+
</div>
|
|
2328
|
+
<div class="tags">
|
|
2329
|
+
<p class="tag_title">Parameters:</p>
|
|
2330
|
+
<ul class="param">
|
|
2331
|
+
|
|
2332
|
+
<li>
|
|
2333
|
+
|
|
2334
|
+
<span class='name'>id</span>
|
|
2335
|
+
|
|
2336
|
+
|
|
2337
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2338
|
+
|
|
2339
|
+
|
|
2340
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
</li>
|
|
2344
|
+
|
|
2345
|
+
<li>
|
|
2346
|
+
|
|
2347
|
+
<span class='name'>description</span>
|
|
2348
|
+
|
|
2349
|
+
|
|
2350
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2351
|
+
|
|
2352
|
+
|
|
2353
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
—
|
|
2357
|
+
<div class='inline'>
|
|
2358
|
+
<p>human-readable description of what this reserved domain will be used for</p>
|
|
2359
|
+
</div>
|
|
2360
|
+
|
|
2361
|
+
</li>
|
|
2362
|
+
|
|
2363
|
+
<li>
|
|
2364
|
+
|
|
2365
|
+
<span class='name'>metadata</span>
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2369
|
+
|
|
2370
|
+
|
|
2371
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2372
|
+
|
|
2373
|
+
|
|
2374
|
+
—
|
|
2375
|
+
<div class='inline'>
|
|
2376
|
+
<p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
|
|
2377
|
+
</div>
|
|
2378
|
+
|
|
2379
|
+
</li>
|
|
2380
|
+
|
|
2381
|
+
<li>
|
|
2382
|
+
|
|
2383
|
+
<span class='name'>http_endpoint_configuration_id</span>
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2387
|
+
|
|
2388
|
+
|
|
2389
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
—
|
|
2393
|
+
<div class='inline'>
|
|
2394
|
+
<p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
|
|
2395
|
+
</div>
|
|
2396
|
+
|
|
2397
|
+
</li>
|
|
2398
|
+
|
|
2399
|
+
<li>
|
|
2400
|
+
|
|
2401
|
+
<span class='name'>https_endpoint_configuration_id</span>
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
—
|
|
2411
|
+
<div class='inline'>
|
|
2412
|
+
<p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
|
|
2413
|
+
</div>
|
|
2414
|
+
|
|
2415
|
+
</li>
|
|
2416
|
+
|
|
2417
|
+
<li>
|
|
2418
|
+
|
|
2419
|
+
<span class='name'>certificate_id</span>
|
|
2420
|
+
|
|
2421
|
+
|
|
2422
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2426
|
+
|
|
2427
|
+
|
|
2428
|
+
—
|
|
2429
|
+
<div class='inline'>
|
|
2430
|
+
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
|
|
2431
|
+
</div>
|
|
2432
|
+
|
|
2433
|
+
</li>
|
|
2434
|
+
|
|
2435
|
+
<li>
|
|
2436
|
+
|
|
2437
|
+
<span class='name'>certificate_management_policy</span>
|
|
2438
|
+
|
|
2439
|
+
|
|
2440
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2441
|
+
|
|
2442
|
+
|
|
2443
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2444
|
+
|
|
2445
|
+
|
|
2446
|
+
—
|
|
2447
|
+
<div class='inline'>
|
|
2448
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p>
|
|
2449
|
+
</div>
|
|
2450
|
+
|
|
2451
|
+
</li>
|
|
2452
|
+
|
|
2453
|
+
</ul>
|
|
2454
|
+
|
|
2455
|
+
<p class="tag_title">Returns:</p>
|
|
2456
|
+
<ul class="return">
|
|
2457
|
+
|
|
2458
|
+
<li>
|
|
2459
|
+
|
|
2460
|
+
|
|
2461
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
|
|
2465
|
+
—
|
|
2466
|
+
<div class='inline'>
|
|
2467
|
+
<p>result from update request</p>
|
|
2468
|
+
</div>
|
|
2469
|
+
|
|
2470
|
+
</li>
|
|
2471
|
+
|
|
2472
|
+
</ul>
|
|
2473
|
+
|
|
2474
|
+
</div><table class="source_code">
|
|
2475
|
+
<tr>
|
|
2476
|
+
<td>
|
|
2477
|
+
<pre class="lines">
|
|
2478
|
+
|
|
2479
|
+
|
|
2480
|
+
176
|
|
2481
|
+
177
|
|
2482
|
+
178
|
|
2483
|
+
179
|
|
2484
|
+
180
|
|
2485
|
+
181
|
|
2486
|
+
182
|
|
2487
|
+
183
|
|
2488
|
+
184
|
|
2489
|
+
185
|
|
2490
|
+
186
|
|
2491
|
+
187
|
|
2492
|
+
188
|
|
2493
|
+
189
|
|
2494
|
+
190
|
|
2495
|
+
191
|
|
2496
|
+
192
|
|
2497
|
+
193
|
|
2498
|
+
194
|
|
2499
|
+
195</pre>
|
|
2500
|
+
</td>
|
|
2501
|
+
<td>
|
|
2502
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 176</span>
|
|
2503
|
+
|
|
2504
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
2505
|
+
<span class='label'>id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2506
|
+
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2507
|
+
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2508
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2509
|
+
<span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2510
|
+
<span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2511
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
2512
|
+
<span class='rparen'>)</span>
|
|
2513
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</span>
|
|
2514
|
+
<span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
|
|
2515
|
+
<span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
|
|
2516
|
+
<span class='label'>http_endpoint_configuration_id:</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span><span class='comma'>,</span>
|
|
2517
|
+
<span class='label'>https_endpoint_configuration_id:</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span><span class='comma'>,</span>
|
|
2518
|
+
<span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
|
|
2519
|
+
<span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
|
2520
|
+
<span class='rparen'>)</span>
|
|
2521
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
2522
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
2523
|
+
<span class='kw'>end</span></pre>
|
|
2524
|
+
</td>
|
|
2525
|
+
</tr>
|
|
2526
|
+
</table>
|
|
2527
|
+
</div>
|
|
2528
|
+
|
|
2529
|
+
</div>
|
|
2530
|
+
|
|
2531
|
+
</div>
|
|
2532
|
+
|
|
2533
|
+
<div id="footer">
|
|
2534
|
+
Generated on Fri Sep 24 19:20:29 2021 by
|
|
2535
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2536
|
+
0.9.26 (ruby-3.0.1).
|
|
2537
|
+
</div>
|
|
2538
|
+
|
|
2539
|
+
</div>
|
|
2540
|
+
</body>
|
|
2541
|
+
</html>
|