linodeapi 0.1.0 → 0.1.1
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 +4 -4
- data/.travis.yml +3 -1
- data/dev/cache_spec.rb +25 -0
- data/dev/spec.yml +1563 -0
- data/lib/linodeapi.rb +57 -1
- data/lib/linodeapi/raw.rb +10 -2
- data/linodeapi.gemspec +5 -5
- metadata +12 -12
- data/dev/update_spec.rb +0 -60
- data/lib/linodeapi/spec.rb +0 -1359
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2bb89d05c98ea7f75197a191ff416262b6264c32
|
|
4
|
+
data.tar.gz: cb9ee0b2f15d1fbd7c5434502e4d37c126be1edd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4cbd8c6355395392e01ddae32c7392cee3950bbbbd2b00c59b8085cc86c5047b5eb2e750e09795767f952f9832e4289ab9b068d2afd6c4479570496c521fb036
|
|
7
|
+
data.tar.gz: 4dc00e59bbb2d9186f9e33bbf969d290ecd5002d7db33292c4c6f1286d998355079d3c66865dfafc2191b26f2cde2f539184f5ef739e8a97815a253ef5c1fd04
|
data/.travis.yml
CHANGED
data/dev/cache_spec.rb
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
require 'linodeapi'
|
|
4
|
+
require 'yaml'
|
|
5
|
+
|
|
6
|
+
SPEC_FILE = $ARGV.first || 'dev/spec.yml'
|
|
7
|
+
|
|
8
|
+
def parse_node(node)
|
|
9
|
+
return clean_node(node) if node[:type] == :call
|
|
10
|
+
Hash[node[:subs].sort.map { |k, v| [k.to_s, parse_node(v)] }]
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
def clean_node(node)
|
|
14
|
+
node.delete(:type)
|
|
15
|
+
hash_to_array(node)
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
def hash_to_array(hash)
|
|
19
|
+
return hash unless hash.is_a? Hash
|
|
20
|
+
hash.to_a.sort.map { |x| Hash[x.first.to_s, hash_to_array(x.last)] }
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
result = parse_node(LinodeAPI.spec)
|
|
24
|
+
|
|
25
|
+
File.open(SPEC_FILE, 'w') { |fh| fh << YAML.dump(result) }
|
data/dev/spec.yml
ADDED
|
@@ -0,0 +1,1563 @@
|
|
|
1
|
+
---
|
|
2
|
+
account:
|
|
3
|
+
estimateinvoice:
|
|
4
|
+
- desc: 'Estimates the invoice for adding a new Linode or NodeBalancer as well as
|
|
5
|
+
resizing a Linode. This returns two fields: PRICE which is the estimated cost
|
|
6
|
+
of the invoice, and INVOICE_TO which is the date invoice would be though with
|
|
7
|
+
timezone set to America/New_York'
|
|
8
|
+
- params:
|
|
9
|
+
- linodeid:
|
|
10
|
+
- desc: This is the LinodeID you want to resize and is required for mode 'linode_resize'.
|
|
11
|
+
- required: false
|
|
12
|
+
- type: :numeric
|
|
13
|
+
- mode:
|
|
14
|
+
- desc: 'This is one of the following options: ''linode_new'', ''linode_resize'',
|
|
15
|
+
or ''nodebalancer_new''.'
|
|
16
|
+
- required: true
|
|
17
|
+
- type: :string
|
|
18
|
+
- paymentterm:
|
|
19
|
+
- desc: 'Subscription term in months. One of: 1, 12, or 24. This is required
|
|
20
|
+
for modes ''linode_new'' and ''nodebalancer_new''.'
|
|
21
|
+
- required: false
|
|
22
|
+
- type: :numeric
|
|
23
|
+
- planid:
|
|
24
|
+
- desc: The desired PlanID available from avail.LinodePlans(). This is required
|
|
25
|
+
for modes 'linode_new' and 'linode_resize'.
|
|
26
|
+
- required: false
|
|
27
|
+
- type: :numeric
|
|
28
|
+
- throws:
|
|
29
|
+
- VALIDATION
|
|
30
|
+
info:
|
|
31
|
+
- desc: Shows information about your account such as the date your account was opened
|
|
32
|
+
as well as your network utilization for the current month in gigabytes.
|
|
33
|
+
- params: []
|
|
34
|
+
- throws: []
|
|
35
|
+
paybalance:
|
|
36
|
+
- desc: Pays current balance on file, returning it in the response.
|
|
37
|
+
- params: []
|
|
38
|
+
- throws:
|
|
39
|
+
- CCEXPIRED
|
|
40
|
+
- CCFAILED
|
|
41
|
+
- NOACCESS
|
|
42
|
+
- PAYMENTLIMITER
|
|
43
|
+
- VALIDATION
|
|
44
|
+
updatecard:
|
|
45
|
+
- desc: ''
|
|
46
|
+
- params:
|
|
47
|
+
- ccexpmonth:
|
|
48
|
+
- desc: ''
|
|
49
|
+
- required: true
|
|
50
|
+
- type: :numeric
|
|
51
|
+
- ccexpyear:
|
|
52
|
+
- desc: ''
|
|
53
|
+
- required: true
|
|
54
|
+
- type: :numeric
|
|
55
|
+
- ccnumber:
|
|
56
|
+
- desc: ''
|
|
57
|
+
- required: true
|
|
58
|
+
- type: :numeric
|
|
59
|
+
- throws: []
|
|
60
|
+
api:
|
|
61
|
+
spec:
|
|
62
|
+
- desc: 'Returns a data structure of the entire Linode API specification. This
|
|
63
|
+
method does not require authorization.<br><br>For example: <a target="_blank"
|
|
64
|
+
href="https://api.linode.com/?api_action=api.spec">https://api.linode.com/?api_action=api.spec</a>'
|
|
65
|
+
- params: []
|
|
66
|
+
- throws: []
|
|
67
|
+
avail:
|
|
68
|
+
datacenters:
|
|
69
|
+
- desc: Returns a list of Linode data center facilities.
|
|
70
|
+
- params: []
|
|
71
|
+
- throws: []
|
|
72
|
+
distributions:
|
|
73
|
+
- desc: Returns a list of available Linux Distributions.
|
|
74
|
+
- params:
|
|
75
|
+
- distributionid:
|
|
76
|
+
- desc: Limits the results to the specified DistributionID
|
|
77
|
+
- required: false
|
|
78
|
+
- type: :numeric
|
|
79
|
+
- throws: []
|
|
80
|
+
kernels:
|
|
81
|
+
- desc: List available kernels.
|
|
82
|
+
- params:
|
|
83
|
+
- isxen:
|
|
84
|
+
- desc: Limits the results to show only Xen kernels
|
|
85
|
+
- required: false
|
|
86
|
+
- type: :boolean
|
|
87
|
+
- kernelid:
|
|
88
|
+
- desc: ''
|
|
89
|
+
- required: false
|
|
90
|
+
- type: :numeric
|
|
91
|
+
- throws: []
|
|
92
|
+
linodeplans:
|
|
93
|
+
- desc: Returns a structure of Linode PlanIDs containing the Plan label and the
|
|
94
|
+
availability in each Datacenter.
|
|
95
|
+
- params:
|
|
96
|
+
- planid:
|
|
97
|
+
- desc: Limits the list to the specified PlanID
|
|
98
|
+
- required: false
|
|
99
|
+
- type: :numeric
|
|
100
|
+
- throws: []
|
|
101
|
+
nodebalancers:
|
|
102
|
+
- desc: Returns NodeBalancer pricing information.
|
|
103
|
+
- params: []
|
|
104
|
+
- throws: []
|
|
105
|
+
stackscripts:
|
|
106
|
+
- desc: Returns a list of available public StackScripts.
|
|
107
|
+
- params:
|
|
108
|
+
- distributionid:
|
|
109
|
+
- desc: Limit the results to StackScripts that can be applied to this DistributionID
|
|
110
|
+
- required: false
|
|
111
|
+
- type: :numeric
|
|
112
|
+
- distributionvendor:
|
|
113
|
+
- desc: Debian, Ubuntu, Fedora, etc.
|
|
114
|
+
- required: false
|
|
115
|
+
- type: :string
|
|
116
|
+
- keywords:
|
|
117
|
+
- desc: Search terms
|
|
118
|
+
- required: false
|
|
119
|
+
- type: :string
|
|
120
|
+
- throws: []
|
|
121
|
+
domain:
|
|
122
|
+
create:
|
|
123
|
+
- desc: Create a domain record.
|
|
124
|
+
- params:
|
|
125
|
+
- axfr_ips:
|
|
126
|
+
- desc: IP addresses allowed to AXFR the entire zone, semicolon separated
|
|
127
|
+
- required: false
|
|
128
|
+
- type: :string
|
|
129
|
+
- description:
|
|
130
|
+
- desc: Currently undisplayed.
|
|
131
|
+
- required: false
|
|
132
|
+
- type: :string
|
|
133
|
+
- domain:
|
|
134
|
+
- desc: The zone's name
|
|
135
|
+
- required: true
|
|
136
|
+
- type: :string
|
|
137
|
+
- expire_sec:
|
|
138
|
+
- desc: ''
|
|
139
|
+
- required: false
|
|
140
|
+
- type: :numeric
|
|
141
|
+
- lpm_displaygroup:
|
|
142
|
+
- desc: Display group in the Domain list inside the Linode DNS Manager
|
|
143
|
+
- required: false
|
|
144
|
+
- type: :string
|
|
145
|
+
- master_ips:
|
|
146
|
+
- desc: 'When type=slave, the zone''s master DNS servers list, semicolon separated '
|
|
147
|
+
- required: false
|
|
148
|
+
- type: :string
|
|
149
|
+
- refresh_sec:
|
|
150
|
+
- desc: ''
|
|
151
|
+
- required: false
|
|
152
|
+
- type: :numeric
|
|
153
|
+
- retry_sec:
|
|
154
|
+
- desc: ''
|
|
155
|
+
- required: false
|
|
156
|
+
- type: :numeric
|
|
157
|
+
- soa_email:
|
|
158
|
+
- desc: Required when type=master
|
|
159
|
+
- required: false
|
|
160
|
+
- type: :string
|
|
161
|
+
- status:
|
|
162
|
+
- desc: 0, 1, or 2 (disabled, active, edit mode)
|
|
163
|
+
- required: false
|
|
164
|
+
- type: :numeric
|
|
165
|
+
- ttl_sec:
|
|
166
|
+
- desc: ''
|
|
167
|
+
- required: false
|
|
168
|
+
- type: :numeric
|
|
169
|
+
- type:
|
|
170
|
+
- desc: master or slave
|
|
171
|
+
- required: true
|
|
172
|
+
- type: :string
|
|
173
|
+
- throws:
|
|
174
|
+
- NOACCESS
|
|
175
|
+
- VALIDATION
|
|
176
|
+
delete:
|
|
177
|
+
- desc: ''
|
|
178
|
+
- params:
|
|
179
|
+
- domainid:
|
|
180
|
+
- desc: ''
|
|
181
|
+
- required: true
|
|
182
|
+
- type: :numeric
|
|
183
|
+
- throws:
|
|
184
|
+
- NOTFOUND
|
|
185
|
+
list:
|
|
186
|
+
- desc: Lists domains you have access to.
|
|
187
|
+
- params:
|
|
188
|
+
- domainid:
|
|
189
|
+
- desc: Limits the list to the specified DomainID
|
|
190
|
+
- required: false
|
|
191
|
+
- type: :numeric
|
|
192
|
+
- throws: []
|
|
193
|
+
resource:
|
|
194
|
+
create:
|
|
195
|
+
- desc: Create a domain record.
|
|
196
|
+
- params:
|
|
197
|
+
- domainid:
|
|
198
|
+
- desc: ''
|
|
199
|
+
- required: true
|
|
200
|
+
- type: :numeric
|
|
201
|
+
- name:
|
|
202
|
+
- desc: The hostname or FQDN. When Type=MX the subdomain to delegate to the
|
|
203
|
+
Target MX server.
|
|
204
|
+
- required: false
|
|
205
|
+
- type: :string
|
|
206
|
+
- port:
|
|
207
|
+
- desc: ''
|
|
208
|
+
- required: false
|
|
209
|
+
- type: :numeric
|
|
210
|
+
- priority:
|
|
211
|
+
- desc: Priority for MX and SRV records, 0-255
|
|
212
|
+
- required: false
|
|
213
|
+
- type: :numeric
|
|
214
|
+
- protocol:
|
|
215
|
+
- desc: The protocol to append to an SRV record. Ignored on other record
|
|
216
|
+
types.
|
|
217
|
+
- required: false
|
|
218
|
+
- type: :string
|
|
219
|
+
- target:
|
|
220
|
+
- desc: When Type=MX the hostname. When Type=CNAME the target of the alias. When
|
|
221
|
+
Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]'
|
|
222
|
+
will be substituted with the IP address of the request.
|
|
223
|
+
- required: false
|
|
224
|
+
- type: :string
|
|
225
|
+
- ttl_sec:
|
|
226
|
+
- desc: TTL. Leave as 0 to accept our default.
|
|
227
|
+
- required: false
|
|
228
|
+
- type: :numeric
|
|
229
|
+
- type:
|
|
230
|
+
- desc: 'One of: NS, MX, A, AAAA, CNAME, TXT, or SRV'
|
|
231
|
+
- required: true
|
|
232
|
+
- type: :string
|
|
233
|
+
- weight:
|
|
234
|
+
- desc: ''
|
|
235
|
+
- required: false
|
|
236
|
+
- type: :numeric
|
|
237
|
+
- throws:
|
|
238
|
+
- NOACCESS
|
|
239
|
+
- VALIDATION
|
|
240
|
+
delete:
|
|
241
|
+
- desc: ''
|
|
242
|
+
- params:
|
|
243
|
+
- domainid:
|
|
244
|
+
- desc: ''
|
|
245
|
+
- required: true
|
|
246
|
+
- type: :numeric
|
|
247
|
+
- resourceid:
|
|
248
|
+
- desc: ''
|
|
249
|
+
- required: true
|
|
250
|
+
- type: :numeric
|
|
251
|
+
- throws:
|
|
252
|
+
- NOTFOUND
|
|
253
|
+
list:
|
|
254
|
+
- desc: ''
|
|
255
|
+
- params:
|
|
256
|
+
- domainid:
|
|
257
|
+
- desc: ''
|
|
258
|
+
- required: true
|
|
259
|
+
- type: :numeric
|
|
260
|
+
- resourceid:
|
|
261
|
+
- desc: ''
|
|
262
|
+
- required: false
|
|
263
|
+
- type: :numeric
|
|
264
|
+
- throws: []
|
|
265
|
+
update:
|
|
266
|
+
- desc: Update a domain record.
|
|
267
|
+
- params:
|
|
268
|
+
- domainid:
|
|
269
|
+
- desc: ''
|
|
270
|
+
- required: false
|
|
271
|
+
- type: :numeric
|
|
272
|
+
- name:
|
|
273
|
+
- desc: The hostname or FQDN. When Type=MX the subdomain to delegate to the
|
|
274
|
+
Target MX server.
|
|
275
|
+
- required: false
|
|
276
|
+
- type: :string
|
|
277
|
+
- port:
|
|
278
|
+
- desc: ''
|
|
279
|
+
- required: false
|
|
280
|
+
- type: :numeric
|
|
281
|
+
- priority:
|
|
282
|
+
- desc: Priority for MX and SRV records, 0-255
|
|
283
|
+
- required: false
|
|
284
|
+
- type: :numeric
|
|
285
|
+
- protocol:
|
|
286
|
+
- desc: The protocol to append to an SRV record. Ignored on other record
|
|
287
|
+
types.
|
|
288
|
+
- required: false
|
|
289
|
+
- type: :string
|
|
290
|
+
- resourceid:
|
|
291
|
+
- desc: ''
|
|
292
|
+
- required: true
|
|
293
|
+
- type: :numeric
|
|
294
|
+
- target:
|
|
295
|
+
- desc: When Type=MX the hostname. When Type=CNAME the target of the alias. When
|
|
296
|
+
Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]'
|
|
297
|
+
will be substituted with the IP address of the request.
|
|
298
|
+
- required: false
|
|
299
|
+
- type: :string
|
|
300
|
+
- ttl_sec:
|
|
301
|
+
- desc: TTL. Leave as 0 to accept our default.
|
|
302
|
+
- required: false
|
|
303
|
+
- type: :numeric
|
|
304
|
+
- weight:
|
|
305
|
+
- desc: ''
|
|
306
|
+
- required: false
|
|
307
|
+
- type: :numeric
|
|
308
|
+
- throws:
|
|
309
|
+
- NOTFOUND
|
|
310
|
+
- VALIDATION
|
|
311
|
+
update:
|
|
312
|
+
- desc: Update a domain record.
|
|
313
|
+
- params:
|
|
314
|
+
- axfr_ips:
|
|
315
|
+
- desc: IP addresses allowed to AXFR the entire zone, semicolon separated
|
|
316
|
+
- required: false
|
|
317
|
+
- type: :string
|
|
318
|
+
- description:
|
|
319
|
+
- desc: Currently undisplayed.
|
|
320
|
+
- required: false
|
|
321
|
+
- type: :string
|
|
322
|
+
- domain:
|
|
323
|
+
- desc: The zone's name
|
|
324
|
+
- required: false
|
|
325
|
+
- type: :string
|
|
326
|
+
- domainid:
|
|
327
|
+
- desc: ''
|
|
328
|
+
- required: true
|
|
329
|
+
- type: :numeric
|
|
330
|
+
- expire_sec:
|
|
331
|
+
- desc: ''
|
|
332
|
+
- required: false
|
|
333
|
+
- type: :numeric
|
|
334
|
+
- lpm_displaygroup:
|
|
335
|
+
- desc: Display group in the Domain list inside the Linode DNS Manager
|
|
336
|
+
- required: false
|
|
337
|
+
- type: :string
|
|
338
|
+
- master_ips:
|
|
339
|
+
- desc: 'When type=slave, the zone''s master DNS servers list, semicolon separated '
|
|
340
|
+
- required: false
|
|
341
|
+
- type: :string
|
|
342
|
+
- refresh_sec:
|
|
343
|
+
- desc: ''
|
|
344
|
+
- required: false
|
|
345
|
+
- type: :numeric
|
|
346
|
+
- retry_sec:
|
|
347
|
+
- desc: ''
|
|
348
|
+
- required: false
|
|
349
|
+
- type: :numeric
|
|
350
|
+
- soa_email:
|
|
351
|
+
- desc: Required when type=master
|
|
352
|
+
- required: false
|
|
353
|
+
- type: :string
|
|
354
|
+
- status:
|
|
355
|
+
- desc: 0, 1, or 2 (disabled, active, edit mode)
|
|
356
|
+
- required: false
|
|
357
|
+
- type: :numeric
|
|
358
|
+
- ttl_sec:
|
|
359
|
+
- desc: ''
|
|
360
|
+
- required: false
|
|
361
|
+
- type: :numeric
|
|
362
|
+
- type:
|
|
363
|
+
- desc: master or slave
|
|
364
|
+
- required: false
|
|
365
|
+
- type: :string
|
|
366
|
+
- throws:
|
|
367
|
+
- NOTFOUND
|
|
368
|
+
- VALIDATION
|
|
369
|
+
image:
|
|
370
|
+
delete:
|
|
371
|
+
- desc: Deletes a gold-master image
|
|
372
|
+
- params:
|
|
373
|
+
- imageid:
|
|
374
|
+
- desc: The ID of the gold-master image to delete
|
|
375
|
+
- required: true
|
|
376
|
+
- type: :numeric
|
|
377
|
+
- throws:
|
|
378
|
+
- NOTFOUND
|
|
379
|
+
list:
|
|
380
|
+
- desc: Lists available gold-master images
|
|
381
|
+
- params:
|
|
382
|
+
- imageid:
|
|
383
|
+
- desc: Request information for a specific gold-master image
|
|
384
|
+
- required: false
|
|
385
|
+
- type: :numeric
|
|
386
|
+
- pending:
|
|
387
|
+
- desc: Show images currently being created.
|
|
388
|
+
- required: false
|
|
389
|
+
- type: :numeric
|
|
390
|
+
- throws:
|
|
391
|
+
- NOTFOUND
|
|
392
|
+
update:
|
|
393
|
+
- desc: Update an Image record.
|
|
394
|
+
- params:
|
|
395
|
+
- description:
|
|
396
|
+
- desc: An optional description of the Image.
|
|
397
|
+
- required: false
|
|
398
|
+
- type: :string
|
|
399
|
+
- imageid:
|
|
400
|
+
- desc: The ID of the Image to modify.
|
|
401
|
+
- required: true
|
|
402
|
+
- type: :numeric
|
|
403
|
+
- label:
|
|
404
|
+
- desc: The label of the Image.
|
|
405
|
+
- required: false
|
|
406
|
+
- type: :string
|
|
407
|
+
- throws:
|
|
408
|
+
- NOTFOUND
|
|
409
|
+
- VALIDATION
|
|
410
|
+
linode:
|
|
411
|
+
boot:
|
|
412
|
+
- desc: Issues a boot job for the provided ConfigID. If no ConfigID is provided
|
|
413
|
+
boots the last used configuration profile, or the first configuration profile
|
|
414
|
+
if this Linode has never been booted.
|
|
415
|
+
- params:
|
|
416
|
+
- configid:
|
|
417
|
+
- desc: The ConfigID to boot, available from linode.config.list().
|
|
418
|
+
- required: false
|
|
419
|
+
- type: :numeric
|
|
420
|
+
- linodeid:
|
|
421
|
+
- desc: ''
|
|
422
|
+
- required: true
|
|
423
|
+
- type: :numeric
|
|
424
|
+
- throws:
|
|
425
|
+
- NOTFOUND
|
|
426
|
+
clone:
|
|
427
|
+
- desc: Creates a new Linode, assigns you full privileges, and then clones the specified
|
|
428
|
+
LinodeID to the new Linode. There is a limit of 5 active clone operations per
|
|
429
|
+
source Linode. It is recommended that the source Linode be powered down during
|
|
430
|
+
the clone.
|
|
431
|
+
- params:
|
|
432
|
+
- datacenterid:
|
|
433
|
+
- desc: The DatacenterID from avail.datacenters() where you wish to place this
|
|
434
|
+
new Linode
|
|
435
|
+
- required: true
|
|
436
|
+
- type: :numeric
|
|
437
|
+
- linodeid:
|
|
438
|
+
- desc: The LinodeID that you want cloned
|
|
439
|
+
- required: true
|
|
440
|
+
- type: :numeric
|
|
441
|
+
- paymentterm:
|
|
442
|
+
- desc: 'Subscription term in months for prepaid customers. One of: 1, 12,
|
|
443
|
+
or 24'
|
|
444
|
+
- required: false
|
|
445
|
+
- type: :numeric
|
|
446
|
+
- planid:
|
|
447
|
+
- desc: The desired PlanID available from avail.LinodePlans()
|
|
448
|
+
- required: true
|
|
449
|
+
- type: :numeric
|
|
450
|
+
- throws:
|
|
451
|
+
- NOACCESS
|
|
452
|
+
- NOTFOUND
|
|
453
|
+
- CCFAILED
|
|
454
|
+
- VALIDATION
|
|
455
|
+
- LINODELIMITER
|
|
456
|
+
- ACCOUNTLIMIT
|
|
457
|
+
config:
|
|
458
|
+
create:
|
|
459
|
+
- desc: Creates a Linode Configuration Profile.
|
|
460
|
+
- params:
|
|
461
|
+
- comments:
|
|
462
|
+
- desc: Comments you wish to save along with this profile
|
|
463
|
+
- required: false
|
|
464
|
+
- type: :string
|
|
465
|
+
- devtmpfs_automount:
|
|
466
|
+
- desc: 'Controls if pv_ops kernels should automount devtmpfs at boot. '
|
|
467
|
+
- required: false
|
|
468
|
+
- type: :boolean
|
|
469
|
+
- disklist:
|
|
470
|
+
- desc: A comma delimited list of DiskIDs; position reflects device node. The
|
|
471
|
+
9th element for specifying the initrd.
|
|
472
|
+
- required: true
|
|
473
|
+
- type: :string
|
|
474
|
+
- helper_depmod:
|
|
475
|
+
- desc: 'Creates an empty modprobe file for the kernel you''re booting. '
|
|
476
|
+
- required: false
|
|
477
|
+
- type: :boolean
|
|
478
|
+
- helper_disableupdatedb:
|
|
479
|
+
- desc: Enable the disableUpdateDB filesystem helper
|
|
480
|
+
- required: false
|
|
481
|
+
- type: :boolean
|
|
482
|
+
- helper_network:
|
|
483
|
+
- desc: Automatically creates network configuration files for your distro
|
|
484
|
+
and places them into your filesystem.
|
|
485
|
+
- required: false
|
|
486
|
+
- type: :boolean
|
|
487
|
+
- helper_xen:
|
|
488
|
+
- desc: Enable the Xen filesystem helper. Corrects fstab and inittab/upstart
|
|
489
|
+
entries depending on the kernel you're booting. You want this.
|
|
490
|
+
- required: false
|
|
491
|
+
- type: :boolean
|
|
492
|
+
- kernelid:
|
|
493
|
+
- desc: The KernelID for this profile. Found in avail.kernels()
|
|
494
|
+
- required: true
|
|
495
|
+
- type: :numeric
|
|
496
|
+
- label:
|
|
497
|
+
- desc: The Label for this profile
|
|
498
|
+
- required: true
|
|
499
|
+
- type: :string
|
|
500
|
+
- linodeid:
|
|
501
|
+
- desc: ''
|
|
502
|
+
- required: true
|
|
503
|
+
- type: :numeric
|
|
504
|
+
- ramlimit:
|
|
505
|
+
- desc: RAMLimit in MB. 0 for max.
|
|
506
|
+
- required: false
|
|
507
|
+
- type: :numeric
|
|
508
|
+
- rootdevicecustom:
|
|
509
|
+
- desc: A custom root device setting.
|
|
510
|
+
- required: false
|
|
511
|
+
- type: :string
|
|
512
|
+
- rootdevicenum:
|
|
513
|
+
- desc: Which device number (1-8) that contains the root partition. 0 to
|
|
514
|
+
utilize RootDeviceCustom.
|
|
515
|
+
- required: false
|
|
516
|
+
- type: :numeric
|
|
517
|
+
- rootdevicero:
|
|
518
|
+
- desc: 'Enables the ''ro'' kernel flag. Modern distros want this. '
|
|
519
|
+
- required: false
|
|
520
|
+
- type: :boolean
|
|
521
|
+
- runlevel:
|
|
522
|
+
- desc: 'One of ''default'', ''single'', ''binbash'' '
|
|
523
|
+
- required: false
|
|
524
|
+
- type: :string
|
|
525
|
+
- throws:
|
|
526
|
+
- NOTFOUND
|
|
527
|
+
- VALIDATION
|
|
528
|
+
delete:
|
|
529
|
+
- desc: Deletes a Linode Configuration Profile.
|
|
530
|
+
- params:
|
|
531
|
+
- configid:
|
|
532
|
+
- desc: ''
|
|
533
|
+
- required: true
|
|
534
|
+
- type: :numeric
|
|
535
|
+
- linodeid:
|
|
536
|
+
- desc: ''
|
|
537
|
+
- required: true
|
|
538
|
+
- type: :numeric
|
|
539
|
+
- throws:
|
|
540
|
+
- NOTFOUND
|
|
541
|
+
- VALIDATION
|
|
542
|
+
list:
|
|
543
|
+
- desc: Lists a Linode's Configuration Profiles.
|
|
544
|
+
- params:
|
|
545
|
+
- configid:
|
|
546
|
+
- desc: ''
|
|
547
|
+
- required: false
|
|
548
|
+
- type: :numeric
|
|
549
|
+
- linodeid:
|
|
550
|
+
- desc: ''
|
|
551
|
+
- required: true
|
|
552
|
+
- type: :numeric
|
|
553
|
+
- throws:
|
|
554
|
+
- NOTFOUND
|
|
555
|
+
update:
|
|
556
|
+
- desc: Updates a Linode Configuration Profile.
|
|
557
|
+
- params:
|
|
558
|
+
- comments:
|
|
559
|
+
- desc: Comments you wish to save along with this profile
|
|
560
|
+
- required: false
|
|
561
|
+
- type: :string
|
|
562
|
+
- configid:
|
|
563
|
+
- desc: ''
|
|
564
|
+
- required: true
|
|
565
|
+
- type: :numeric
|
|
566
|
+
- devtmpfs_automount:
|
|
567
|
+
- desc: 'Controls if pv_ops kernels should automount devtmpfs at boot. '
|
|
568
|
+
- required: false
|
|
569
|
+
- type: :boolean
|
|
570
|
+
- disklist:
|
|
571
|
+
- desc: A comma delimited list of DiskIDs; position reflects device node. The
|
|
572
|
+
9th element for specifying the initrd.
|
|
573
|
+
- required: false
|
|
574
|
+
- type: :string
|
|
575
|
+
- helper_depmod:
|
|
576
|
+
- desc: 'Creates an empty modprobe file for the kernel you''re booting. '
|
|
577
|
+
- required: false
|
|
578
|
+
- type: :boolean
|
|
579
|
+
- helper_disableupdatedb:
|
|
580
|
+
- desc: Enable the disableUpdateDB filesystem helper
|
|
581
|
+
- required: false
|
|
582
|
+
- type: :boolean
|
|
583
|
+
- helper_network:
|
|
584
|
+
- desc: Automatically creates network configuration files for your distro
|
|
585
|
+
and places them into your filesystem.
|
|
586
|
+
- required: false
|
|
587
|
+
- type: :boolean
|
|
588
|
+
- helper_xen:
|
|
589
|
+
- desc: Enable the Xen filesystem helper. Corrects fstab and inittab/upstart
|
|
590
|
+
entries depending on the kernel you're booting. You want this.
|
|
591
|
+
- required: false
|
|
592
|
+
- type: :boolean
|
|
593
|
+
- kernelid:
|
|
594
|
+
- desc: The KernelID for this profile. Found in avail.kernels()
|
|
595
|
+
- required: false
|
|
596
|
+
- type: :numeric
|
|
597
|
+
- label:
|
|
598
|
+
- desc: The Label for this profile
|
|
599
|
+
- required: false
|
|
600
|
+
- type: :string
|
|
601
|
+
- linodeid:
|
|
602
|
+
- desc: ''
|
|
603
|
+
- required: false
|
|
604
|
+
- type: :numeric
|
|
605
|
+
- ramlimit:
|
|
606
|
+
- desc: RAMLimit in MB. 0 for max.
|
|
607
|
+
- required: false
|
|
608
|
+
- type: :numeric
|
|
609
|
+
- rootdevicecustom:
|
|
610
|
+
- desc: A custom root device setting.
|
|
611
|
+
- required: false
|
|
612
|
+
- type: :string
|
|
613
|
+
- rootdevicenum:
|
|
614
|
+
- desc: Which device number (1-8) that contains the root partition. 0 to
|
|
615
|
+
utilize RootDeviceCustom.
|
|
616
|
+
- required: false
|
|
617
|
+
- type: :numeric
|
|
618
|
+
- rootdevicero:
|
|
619
|
+
- desc: 'Enables the ''ro'' kernel flag. Modern distros want this. '
|
|
620
|
+
- required: false
|
|
621
|
+
- type: :boolean
|
|
622
|
+
- runlevel:
|
|
623
|
+
- desc: 'One of ''default'', ''single'', ''binbash'' '
|
|
624
|
+
- required: false
|
|
625
|
+
- type: :string
|
|
626
|
+
- throws:
|
|
627
|
+
- NOTFOUND
|
|
628
|
+
- VALIDATION
|
|
629
|
+
create:
|
|
630
|
+
- desc: Creates a Linode and assigns you full privileges. There is a 75-linodes-per-hour
|
|
631
|
+
limiter.
|
|
632
|
+
- params:
|
|
633
|
+
- datacenterid:
|
|
634
|
+
- desc: The DatacenterID from avail.datacenters() where you wish to place this
|
|
635
|
+
new Linode
|
|
636
|
+
- required: true
|
|
637
|
+
- type: :numeric
|
|
638
|
+
- paymentterm:
|
|
639
|
+
- desc: 'Subscription term in months for prepaid customers. One of: 1, 12,
|
|
640
|
+
or 24'
|
|
641
|
+
- required: false
|
|
642
|
+
- type: :numeric
|
|
643
|
+
- planid:
|
|
644
|
+
- desc: The desired PlanID available from avail.LinodePlans()
|
|
645
|
+
- required: true
|
|
646
|
+
- type: :numeric
|
|
647
|
+
- throws:
|
|
648
|
+
- NOACCESS
|
|
649
|
+
- CCFAILED
|
|
650
|
+
- VALIDATION
|
|
651
|
+
- LINODELIMITER
|
|
652
|
+
- ACCOUNTLIMIT
|
|
653
|
+
delete:
|
|
654
|
+
- desc: Immediately removes a Linode from your account and issues a pro-rated credit
|
|
655
|
+
back to your account, if applicable. To prevent accidental deletes, this requires
|
|
656
|
+
the Linode has no Disk images. You must first delete its disk images."
|
|
657
|
+
- params:
|
|
658
|
+
- linodeid:
|
|
659
|
+
- desc: The LinodeID to delete
|
|
660
|
+
- required: true
|
|
661
|
+
- type: :numeric
|
|
662
|
+
- skipchecks:
|
|
663
|
+
- desc: Skips the safety checks and will always delete the Linode
|
|
664
|
+
- required: false
|
|
665
|
+
- type: :boolean
|
|
666
|
+
- throws:
|
|
667
|
+
- NOTFOUND
|
|
668
|
+
- LINODENOTEMPTY
|
|
669
|
+
disk:
|
|
670
|
+
create:
|
|
671
|
+
- desc: ''
|
|
672
|
+
- params:
|
|
673
|
+
- fromdistributionid:
|
|
674
|
+
- desc: ''
|
|
675
|
+
- required: false
|
|
676
|
+
- type: :numeric
|
|
677
|
+
- isreadonly:
|
|
678
|
+
- desc: Enable forced read-only for this Disk
|
|
679
|
+
- required: false
|
|
680
|
+
- type: :boolean
|
|
681
|
+
- label:
|
|
682
|
+
- desc: The display label for this Disk
|
|
683
|
+
- required: true
|
|
684
|
+
- type: :string
|
|
685
|
+
- linodeid:
|
|
686
|
+
- desc: ''
|
|
687
|
+
- required: true
|
|
688
|
+
- type: :numeric
|
|
689
|
+
- rootpass:
|
|
690
|
+
- desc: ''
|
|
691
|
+
- required: false
|
|
692
|
+
- type: :string
|
|
693
|
+
- rootsshkey:
|
|
694
|
+
- desc: ''
|
|
695
|
+
- required: false
|
|
696
|
+
- type: :string
|
|
697
|
+
- size:
|
|
698
|
+
- desc: The size in MB of this Disk.
|
|
699
|
+
- required: true
|
|
700
|
+
- type: :numeric
|
|
701
|
+
- type:
|
|
702
|
+
- desc: 'The formatted type of this disk. Valid types are: ext3, ext4, swap,
|
|
703
|
+
raw'
|
|
704
|
+
- required: true
|
|
705
|
+
- type: :string
|
|
706
|
+
- throws:
|
|
707
|
+
- NOTFOUND
|
|
708
|
+
- VALIDATION
|
|
709
|
+
createfromdistribution:
|
|
710
|
+
- desc: ''
|
|
711
|
+
- params:
|
|
712
|
+
- distributionid:
|
|
713
|
+
- desc: The DistributionID to create this disk from. Found in avail.distributions()
|
|
714
|
+
- required: true
|
|
715
|
+
- type: :numeric
|
|
716
|
+
- label:
|
|
717
|
+
- desc: The label of this new disk image
|
|
718
|
+
- required: true
|
|
719
|
+
- type: :string
|
|
720
|
+
- linodeid:
|
|
721
|
+
- desc: ''
|
|
722
|
+
- required: true
|
|
723
|
+
- type: :numeric
|
|
724
|
+
- rootpass:
|
|
725
|
+
- desc: The root user's password
|
|
726
|
+
- required: true
|
|
727
|
+
- type: :string
|
|
728
|
+
- rootsshkey:
|
|
729
|
+
- desc: Optionally sets this string into /root/.ssh/authorized_keys upon distribution
|
|
730
|
+
configuration.
|
|
731
|
+
- required: false
|
|
732
|
+
- type: :string
|
|
733
|
+
- size:
|
|
734
|
+
- desc: Size of this disk image in MB
|
|
735
|
+
- required: true
|
|
736
|
+
- type: :numeric
|
|
737
|
+
- throws:
|
|
738
|
+
- NOTFOUND
|
|
739
|
+
- VALIDATION
|
|
740
|
+
createfromimage:
|
|
741
|
+
- desc: Creates a new disk from a previously imagized disk.
|
|
742
|
+
- params:
|
|
743
|
+
- imageid:
|
|
744
|
+
- desc: The ID of the frozen image to deploy from
|
|
745
|
+
- required: true
|
|
746
|
+
- type: :numeric
|
|
747
|
+
- label:
|
|
748
|
+
- desc: The label of this new disk image
|
|
749
|
+
- required: false
|
|
750
|
+
- type: :string
|
|
751
|
+
- linodeid:
|
|
752
|
+
- desc: Specifies the Linode to deploy on to
|
|
753
|
+
- required: true
|
|
754
|
+
- type: :numeric
|
|
755
|
+
- rootpass:
|
|
756
|
+
- desc: Optionally sets the root password at deployment time. If a password
|
|
757
|
+
is not provided the existing root password of the frozen image will not
|
|
758
|
+
be modified
|
|
759
|
+
- required: false
|
|
760
|
+
- type: :string
|
|
761
|
+
- rootsshkey:
|
|
762
|
+
- desc: Optionally sets this string into /root/.ssh/authorized_keys upon image
|
|
763
|
+
deployment
|
|
764
|
+
- required: false
|
|
765
|
+
- type: :string
|
|
766
|
+
- size:
|
|
767
|
+
- desc: The size of the disk image to creates. Defaults to the minimum size
|
|
768
|
+
required for the requested image
|
|
769
|
+
- required: false
|
|
770
|
+
- type: :numeric
|
|
771
|
+
- throws: []
|
|
772
|
+
createfromstackscript:
|
|
773
|
+
- desc: ''
|
|
774
|
+
- params:
|
|
775
|
+
- distributionid:
|
|
776
|
+
- desc: Which Distribution to apply this StackScript to. Must be one from
|
|
777
|
+
the script's DistributionIDList
|
|
778
|
+
- required: true
|
|
779
|
+
- type: :numeric
|
|
780
|
+
- label:
|
|
781
|
+
- desc: The label of this new disk image
|
|
782
|
+
- required: true
|
|
783
|
+
- type: :string
|
|
784
|
+
- linodeid:
|
|
785
|
+
- desc: ''
|
|
786
|
+
- required: true
|
|
787
|
+
- type: :numeric
|
|
788
|
+
- rootpass:
|
|
789
|
+
- desc: The root user's password
|
|
790
|
+
- required: true
|
|
791
|
+
- type: :string
|
|
792
|
+
- rootsshkey:
|
|
793
|
+
- desc: Optionally sets this string into /root/.ssh/authorized_keys upon distribution
|
|
794
|
+
configuration.
|
|
795
|
+
- required: false
|
|
796
|
+
- type: :string
|
|
797
|
+
- size:
|
|
798
|
+
- desc: Size of this disk image in MB
|
|
799
|
+
- required: true
|
|
800
|
+
- type: :numeric
|
|
801
|
+
- stackscriptid:
|
|
802
|
+
- desc: The StackScript to create this image from
|
|
803
|
+
- required: true
|
|
804
|
+
- type: :numeric
|
|
805
|
+
- stackscriptudfresponses:
|
|
806
|
+
- desc: JSON encoded name/value pairs, answering this StackScript's User Defined
|
|
807
|
+
Fields
|
|
808
|
+
- required: true
|
|
809
|
+
- type: :string
|
|
810
|
+
- throws:
|
|
811
|
+
- NOTFOUND
|
|
812
|
+
- VALIDATION
|
|
813
|
+
delete:
|
|
814
|
+
- desc: ''
|
|
815
|
+
- params:
|
|
816
|
+
- diskid:
|
|
817
|
+
- desc: ''
|
|
818
|
+
- required: true
|
|
819
|
+
- type: :numeric
|
|
820
|
+
- linodeid:
|
|
821
|
+
- desc: ''
|
|
822
|
+
- required: true
|
|
823
|
+
- type: :numeric
|
|
824
|
+
- throws:
|
|
825
|
+
- NOTFOUND
|
|
826
|
+
- VALIDATION
|
|
827
|
+
duplicate:
|
|
828
|
+
- desc: Performs a bit-for-bit copy of a disk image.
|
|
829
|
+
- params:
|
|
830
|
+
- diskid:
|
|
831
|
+
- desc: ''
|
|
832
|
+
- required: true
|
|
833
|
+
- type: :numeric
|
|
834
|
+
- linodeid:
|
|
835
|
+
- desc: ''
|
|
836
|
+
- required: true
|
|
837
|
+
- type: :numeric
|
|
838
|
+
- throws:
|
|
839
|
+
- NOTFOUND
|
|
840
|
+
- VALIDATION
|
|
841
|
+
imagize:
|
|
842
|
+
- desc: Creates a gold-master image for future deployments
|
|
843
|
+
- params:
|
|
844
|
+
- description:
|
|
845
|
+
- desc: An optional description of the created image
|
|
846
|
+
- required: false
|
|
847
|
+
- type: :string
|
|
848
|
+
- diskid:
|
|
849
|
+
- desc: Specifies the source Disk to create the image from
|
|
850
|
+
- required: true
|
|
851
|
+
- type: :numeric
|
|
852
|
+
- label:
|
|
853
|
+
- desc: Sets the name of the image shown in the base image list, defaults
|
|
854
|
+
to the source image label
|
|
855
|
+
- required: false
|
|
856
|
+
- type: :string
|
|
857
|
+
- linodeid:
|
|
858
|
+
- desc: Specifies the source Linode to create the image from
|
|
859
|
+
- required: true
|
|
860
|
+
- type: :numeric
|
|
861
|
+
- throws: []
|
|
862
|
+
list:
|
|
863
|
+
- desc: 'Status values are 1: Ready and 2: Being Deleted.'
|
|
864
|
+
- params:
|
|
865
|
+
- diskid:
|
|
866
|
+
- desc: ''
|
|
867
|
+
- required: false
|
|
868
|
+
- type: :numeric
|
|
869
|
+
- linodeid:
|
|
870
|
+
- desc: ''
|
|
871
|
+
- required: true
|
|
872
|
+
- type: :numeric
|
|
873
|
+
- throws: []
|
|
874
|
+
resize:
|
|
875
|
+
- desc: ''
|
|
876
|
+
- params:
|
|
877
|
+
- diskid:
|
|
878
|
+
- desc: ''
|
|
879
|
+
- required: true
|
|
880
|
+
- type: :numeric
|
|
881
|
+
- linodeid:
|
|
882
|
+
- desc: ''
|
|
883
|
+
- required: true
|
|
884
|
+
- type: :numeric
|
|
885
|
+
- size:
|
|
886
|
+
- desc: The requested new size of this Disk in MB
|
|
887
|
+
- required: true
|
|
888
|
+
- type: :numeric
|
|
889
|
+
- throws:
|
|
890
|
+
- NOTFOUND
|
|
891
|
+
- VALIDATION
|
|
892
|
+
update:
|
|
893
|
+
- desc: ''
|
|
894
|
+
- params:
|
|
895
|
+
- diskid:
|
|
896
|
+
- desc: ''
|
|
897
|
+
- required: true
|
|
898
|
+
- type: :numeric
|
|
899
|
+
- isreadonly:
|
|
900
|
+
- desc: Enable forced read-only for this Disk
|
|
901
|
+
- required: false
|
|
902
|
+
- type: :boolean
|
|
903
|
+
- label:
|
|
904
|
+
- desc: The display label for this Disk
|
|
905
|
+
- required: false
|
|
906
|
+
- type: :string
|
|
907
|
+
- linodeid:
|
|
908
|
+
- desc: ''
|
|
909
|
+
- required: false
|
|
910
|
+
- type: :numeric
|
|
911
|
+
- throws:
|
|
912
|
+
- NOTFOUND
|
|
913
|
+
- VALIDATION
|
|
914
|
+
ip:
|
|
915
|
+
addprivate:
|
|
916
|
+
- desc: Assigns a Private IP to a Linode. Returns the IPAddressID that was added.
|
|
917
|
+
- params:
|
|
918
|
+
- linodeid:
|
|
919
|
+
- desc: ''
|
|
920
|
+
- required: true
|
|
921
|
+
- type: :numeric
|
|
922
|
+
- throws:
|
|
923
|
+
- NOTFOUND
|
|
924
|
+
addpublic:
|
|
925
|
+
- desc: Assigns a Public IP to a Linode. Returns the IPAddressID and IPAddress
|
|
926
|
+
that was added.
|
|
927
|
+
- params:
|
|
928
|
+
- linodeid:
|
|
929
|
+
- desc: The LinodeID of the Linode that will be assigned an additional public
|
|
930
|
+
IP address
|
|
931
|
+
- required: true
|
|
932
|
+
- type: :numeric
|
|
933
|
+
- throws:
|
|
934
|
+
- NOTFOUND
|
|
935
|
+
- VALIDATION
|
|
936
|
+
list:
|
|
937
|
+
- desc: Returns the IP addresses of all Linodes you have access to.
|
|
938
|
+
- params:
|
|
939
|
+
- ipaddressid:
|
|
940
|
+
- desc: If specified, limits the result to this IPAddressID
|
|
941
|
+
- required: false
|
|
942
|
+
- type: :numeric
|
|
943
|
+
- linodeid:
|
|
944
|
+
- desc: If specified, limits the result to this LinodeID
|
|
945
|
+
- required: false
|
|
946
|
+
- type: :numeric
|
|
947
|
+
- throws:
|
|
948
|
+
- NOTFOUND
|
|
949
|
+
setrdns:
|
|
950
|
+
- desc: Sets the rDNS name of a Public IP. Returns the IPAddressID and IPAddress
|
|
951
|
+
that were updated.
|
|
952
|
+
- params:
|
|
953
|
+
- hostname:
|
|
954
|
+
- desc: The hostname to set the reverse DNS to
|
|
955
|
+
- required: true
|
|
956
|
+
- type: :string
|
|
957
|
+
- ipaddressid:
|
|
958
|
+
- desc: The IPAddressID of the address to update
|
|
959
|
+
- required: true
|
|
960
|
+
- type: :numeric
|
|
961
|
+
- throws:
|
|
962
|
+
- NOTFOUND
|
|
963
|
+
- VALIDATION
|
|
964
|
+
swap:
|
|
965
|
+
- desc: Exchanges Public IP addresses between two Linodes within a Datacenter. The
|
|
966
|
+
destination of the IP Address can be designated by either the toLinodeID or
|
|
967
|
+
withIPAddressID parameter. Returns the resulting relationship of the Linode
|
|
968
|
+
and IP Address parameters. When performing a one directional swap, the source
|
|
969
|
+
is represented by the first of the two resultant array members.
|
|
970
|
+
- params:
|
|
971
|
+
- ipaddressid:
|
|
972
|
+
- desc: The IPAddressID of an IP Address to transfer or swap
|
|
973
|
+
- required: true
|
|
974
|
+
- type: :numeric
|
|
975
|
+
- tolinodeid:
|
|
976
|
+
- desc: The LinodeID of the Linode where IPAddressID will be transfered
|
|
977
|
+
- required: false
|
|
978
|
+
- type: :numeric
|
|
979
|
+
- withipaddressid:
|
|
980
|
+
- desc: The IP Address ID to swap
|
|
981
|
+
- required: false
|
|
982
|
+
- type: :numeric
|
|
983
|
+
- throws:
|
|
984
|
+
- NOTFOUND
|
|
985
|
+
- VALIDATION
|
|
986
|
+
job:
|
|
987
|
+
list:
|
|
988
|
+
- desc: ''
|
|
989
|
+
- params:
|
|
990
|
+
- jobid:
|
|
991
|
+
- desc: Limits the list to the specified JobID
|
|
992
|
+
- required: false
|
|
993
|
+
- type: :numeric
|
|
994
|
+
- linodeid:
|
|
995
|
+
- desc: ''
|
|
996
|
+
- required: true
|
|
997
|
+
- type: :numeric
|
|
998
|
+
- pendingonly:
|
|
999
|
+
- desc: ''
|
|
1000
|
+
- required: false
|
|
1001
|
+
- type: :boolean
|
|
1002
|
+
- throws: []
|
|
1003
|
+
list:
|
|
1004
|
+
- desc: 'Returns a list of all Linodes user has access or delete to, including some
|
|
1005
|
+
properties. Status values are -1: Being Created, 0: Brand New, 1: Running,
|
|
1006
|
+
and 2: Powered Off.'
|
|
1007
|
+
- params:
|
|
1008
|
+
- linodeid:
|
|
1009
|
+
- desc: Limits the list to the specified LinodeID
|
|
1010
|
+
- required: false
|
|
1011
|
+
- type: :numeric
|
|
1012
|
+
- throws: []
|
|
1013
|
+
mutate:
|
|
1014
|
+
- desc: Upgrades a Linode to its next generation.
|
|
1015
|
+
- params:
|
|
1016
|
+
- linodeid:
|
|
1017
|
+
- desc: ''
|
|
1018
|
+
- required: true
|
|
1019
|
+
- type: :numeric
|
|
1020
|
+
- throws:
|
|
1021
|
+
- NOTFOUND
|
|
1022
|
+
- VALIDATION
|
|
1023
|
+
reboot:
|
|
1024
|
+
- desc: Issues a shutdown, and then boot job for a given LinodeID.
|
|
1025
|
+
- params:
|
|
1026
|
+
- configid:
|
|
1027
|
+
- desc: ''
|
|
1028
|
+
- required: false
|
|
1029
|
+
- type: :numeric
|
|
1030
|
+
- linodeid:
|
|
1031
|
+
- desc: ''
|
|
1032
|
+
- required: true
|
|
1033
|
+
- type: :numeric
|
|
1034
|
+
- throws:
|
|
1035
|
+
- NOTFOUND
|
|
1036
|
+
resize:
|
|
1037
|
+
- desc: Resizes a Linode from one plan to another. Immediately shuts the Linode
|
|
1038
|
+
down, charges/credits the account, and issue a migration to another host server.
|
|
1039
|
+
- params:
|
|
1040
|
+
- linodeid:
|
|
1041
|
+
- desc: ''
|
|
1042
|
+
- required: true
|
|
1043
|
+
- type: :numeric
|
|
1044
|
+
- planid:
|
|
1045
|
+
- desc: The desired PlanID available from avail.LinodePlans()
|
|
1046
|
+
- required: true
|
|
1047
|
+
- type: :numeric
|
|
1048
|
+
- throws:
|
|
1049
|
+
- NOTFOUND
|
|
1050
|
+
- CCFAILED
|
|
1051
|
+
- VALIDATION
|
|
1052
|
+
shutdown:
|
|
1053
|
+
- desc: Issues a shutdown job for a given LinodeID.
|
|
1054
|
+
- params:
|
|
1055
|
+
- linodeid:
|
|
1056
|
+
- desc: ''
|
|
1057
|
+
- required: true
|
|
1058
|
+
- type: :numeric
|
|
1059
|
+
- throws:
|
|
1060
|
+
- NOTFOUND
|
|
1061
|
+
update:
|
|
1062
|
+
- desc: Updates a Linode's properties.
|
|
1063
|
+
- params:
|
|
1064
|
+
- alert_bwin_enabled:
|
|
1065
|
+
- desc: Enable the incoming bandwidth email alert
|
|
1066
|
+
- required: false
|
|
1067
|
+
- type: :boolean
|
|
1068
|
+
- alert_bwin_threshold:
|
|
1069
|
+
- desc: Mb/sec
|
|
1070
|
+
- required: false
|
|
1071
|
+
- type: :numeric
|
|
1072
|
+
- alert_bwout_enabled:
|
|
1073
|
+
- desc: Enable the outgoing bandwidth email alert
|
|
1074
|
+
- required: false
|
|
1075
|
+
- type: :boolean
|
|
1076
|
+
- alert_bwout_threshold:
|
|
1077
|
+
- desc: Mb/sec
|
|
1078
|
+
- required: false
|
|
1079
|
+
- type: :numeric
|
|
1080
|
+
- alert_bwquota_enabled:
|
|
1081
|
+
- desc: Enable the bw quote email alert
|
|
1082
|
+
- required: false
|
|
1083
|
+
- type: :boolean
|
|
1084
|
+
- alert_bwquota_threshold:
|
|
1085
|
+
- desc: Percentage of monthly bw quota
|
|
1086
|
+
- required: false
|
|
1087
|
+
- type: :numeric
|
|
1088
|
+
- alert_cpu_enabled:
|
|
1089
|
+
- desc: Enable the cpu usage email alert
|
|
1090
|
+
- required: false
|
|
1091
|
+
- type: :boolean
|
|
1092
|
+
- alert_cpu_threshold:
|
|
1093
|
+
- desc: CPU Alert threshold, percentage 0-800
|
|
1094
|
+
- required: false
|
|
1095
|
+
- type: :numeric
|
|
1096
|
+
- alert_diskio_enabled:
|
|
1097
|
+
- desc: Enable the disk IO email alert
|
|
1098
|
+
- required: false
|
|
1099
|
+
- type: :boolean
|
|
1100
|
+
- alert_diskio_threshold:
|
|
1101
|
+
- desc: IO ops/sec
|
|
1102
|
+
- required: false
|
|
1103
|
+
- type: :numeric
|
|
1104
|
+
- backupweeklyday:
|
|
1105
|
+
- desc: ''
|
|
1106
|
+
- required: false
|
|
1107
|
+
- type: :numeric
|
|
1108
|
+
- backupwindow:
|
|
1109
|
+
- desc: ''
|
|
1110
|
+
- required: false
|
|
1111
|
+
- type: :numeric
|
|
1112
|
+
- label:
|
|
1113
|
+
- desc: This Linode's label
|
|
1114
|
+
- required: false
|
|
1115
|
+
- type: :string
|
|
1116
|
+
- linodeid:
|
|
1117
|
+
- desc: ''
|
|
1118
|
+
- required: true
|
|
1119
|
+
- type: :numeric
|
|
1120
|
+
- lpm_displaygroup:
|
|
1121
|
+
- desc: Display group in the Linode list inside the Linode Manager
|
|
1122
|
+
- required: false
|
|
1123
|
+
- type: :string
|
|
1124
|
+
- ms_ssh_disabled:
|
|
1125
|
+
- desc: ''
|
|
1126
|
+
- required: false
|
|
1127
|
+
- type: :boolean
|
|
1128
|
+
- ms_ssh_ip:
|
|
1129
|
+
- desc: ''
|
|
1130
|
+
- required: false
|
|
1131
|
+
- type: :string
|
|
1132
|
+
- ms_ssh_port:
|
|
1133
|
+
- desc: ''
|
|
1134
|
+
- required: false
|
|
1135
|
+
- type: :numeric
|
|
1136
|
+
- ms_ssh_user:
|
|
1137
|
+
- desc: ''
|
|
1138
|
+
- required: false
|
|
1139
|
+
- type: :string
|
|
1140
|
+
- watchdog:
|
|
1141
|
+
- desc: Enable the Lassie shutdown watchdog
|
|
1142
|
+
- required: false
|
|
1143
|
+
- type: :boolean
|
|
1144
|
+
- throws:
|
|
1145
|
+
- NOTFOUND
|
|
1146
|
+
- VALIDATION
|
|
1147
|
+
webconsoletoken:
|
|
1148
|
+
- desc: Generates a console token starting a web console LISH session for the requesting
|
|
1149
|
+
IP
|
|
1150
|
+
- params:
|
|
1151
|
+
- linodeid:
|
|
1152
|
+
- desc: ''
|
|
1153
|
+
- required: true
|
|
1154
|
+
- type: :numeric
|
|
1155
|
+
- throws:
|
|
1156
|
+
- NOTFOUND
|
|
1157
|
+
- VALIDATION
|
|
1158
|
+
nodebalancer:
|
|
1159
|
+
config:
|
|
1160
|
+
create:
|
|
1161
|
+
- desc: ''
|
|
1162
|
+
- params:
|
|
1163
|
+
- algorithm:
|
|
1164
|
+
- desc: Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
|
|
1165
|
+
- required: false
|
|
1166
|
+
- type: :string
|
|
1167
|
+
- check:
|
|
1168
|
+
- desc: Perform active health checks on the backend nodes. One of 'connection',
|
|
1169
|
+
'http', 'http_body'
|
|
1170
|
+
- required: false
|
|
1171
|
+
- type: :string
|
|
1172
|
+
- check_attempts:
|
|
1173
|
+
- desc: Number of failed probes before taking a node out of rotation. 1-30
|
|
1174
|
+
- required: false
|
|
1175
|
+
- type: :string
|
|
1176
|
+
- check_body:
|
|
1177
|
+
- desc: When check=http_body, a regex against the expected result body
|
|
1178
|
+
- required: false
|
|
1179
|
+
- type: :string
|
|
1180
|
+
- check_interval:
|
|
1181
|
+
- desc: Seconds between health check probes. 2-3600
|
|
1182
|
+
- required: false
|
|
1183
|
+
- type: :numeric
|
|
1184
|
+
- check_path:
|
|
1185
|
+
- desc: When check=http, the path to request
|
|
1186
|
+
- required: false
|
|
1187
|
+
- type: :string
|
|
1188
|
+
- check_timeout:
|
|
1189
|
+
- desc: Seconds to wait before considering the probe a failure. 1-30. Must
|
|
1190
|
+
be less than check_interval.
|
|
1191
|
+
- required: false
|
|
1192
|
+
- type: :string
|
|
1193
|
+
- nodebalancerid:
|
|
1194
|
+
- desc: The parent NodeBalancer's ID
|
|
1195
|
+
- required: true
|
|
1196
|
+
- type: :numeric
|
|
1197
|
+
- port:
|
|
1198
|
+
- desc: Port to bind to on the public interfaces. 1-65534
|
|
1199
|
+
- required: false
|
|
1200
|
+
- type: :numeric
|
|
1201
|
+
- protocol:
|
|
1202
|
+
- desc: Either 'tcp', 'http', or 'https'
|
|
1203
|
+
- required: false
|
|
1204
|
+
- type: :string
|
|
1205
|
+
- ssl_cert:
|
|
1206
|
+
- desc: SSL certificate served by the NodeBalancer when the protocol is 'https'
|
|
1207
|
+
- required: false
|
|
1208
|
+
- type: :string
|
|
1209
|
+
- ssl_key:
|
|
1210
|
+
- desc: Unpassphrased private key for the SSL certificate when protocol is
|
|
1211
|
+
'https'
|
|
1212
|
+
- required: false
|
|
1213
|
+
- type: :string
|
|
1214
|
+
- stickiness:
|
|
1215
|
+
- desc: Session persistence. One of 'none', 'table', 'http_cookie'
|
|
1216
|
+
- required: false
|
|
1217
|
+
- type: :string
|
|
1218
|
+
- throws:
|
|
1219
|
+
- NOTFOUND
|
|
1220
|
+
- VALIDATION
|
|
1221
|
+
delete:
|
|
1222
|
+
- desc: Deletes a NodeBalancer's Config
|
|
1223
|
+
- params:
|
|
1224
|
+
- configid:
|
|
1225
|
+
- desc: The ConfigID to delete
|
|
1226
|
+
- required: true
|
|
1227
|
+
- type: :numeric
|
|
1228
|
+
- nodebalancerid:
|
|
1229
|
+
- desc: ''
|
|
1230
|
+
- required: true
|
|
1231
|
+
- type: :numeric
|
|
1232
|
+
- throws:
|
|
1233
|
+
- NOTFOUND
|
|
1234
|
+
list:
|
|
1235
|
+
- desc: Returns a list of NodeBalancers this user has access or delete to, including
|
|
1236
|
+
their properties
|
|
1237
|
+
- params:
|
|
1238
|
+
- configid:
|
|
1239
|
+
- desc: Limits the list to the specified ConfigID
|
|
1240
|
+
- required: false
|
|
1241
|
+
- type: :numeric
|
|
1242
|
+
- nodebalancerid:
|
|
1243
|
+
- desc: ''
|
|
1244
|
+
- required: true
|
|
1245
|
+
- type: :numeric
|
|
1246
|
+
- throws: []
|
|
1247
|
+
update:
|
|
1248
|
+
- desc: Updates a Config's properties
|
|
1249
|
+
- params:
|
|
1250
|
+
- algorithm:
|
|
1251
|
+
- desc: Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
|
|
1252
|
+
- required: false
|
|
1253
|
+
- type: :string
|
|
1254
|
+
- check:
|
|
1255
|
+
- desc: Perform active health checks on the backend nodes. One of 'connection',
|
|
1256
|
+
'http', 'http_body'
|
|
1257
|
+
- required: false
|
|
1258
|
+
- type: :string
|
|
1259
|
+
- check_attempts:
|
|
1260
|
+
- desc: Number of failed probes before taking a node out of rotation. 1-30
|
|
1261
|
+
- required: false
|
|
1262
|
+
- type: :string
|
|
1263
|
+
- check_body:
|
|
1264
|
+
- desc: When check=http_body, a regex against the expected result body
|
|
1265
|
+
- required: false
|
|
1266
|
+
- type: :string
|
|
1267
|
+
- check_interval:
|
|
1268
|
+
- desc: Seconds between health check probes. 2-3600
|
|
1269
|
+
- required: false
|
|
1270
|
+
- type: :numeric
|
|
1271
|
+
- check_path:
|
|
1272
|
+
- desc: When check=http, the path to request
|
|
1273
|
+
- required: false
|
|
1274
|
+
- type: :string
|
|
1275
|
+
- check_timeout:
|
|
1276
|
+
- desc: Seconds to wait before considering the probe a failure. 1-30. Must
|
|
1277
|
+
be less than check_interval.
|
|
1278
|
+
- required: false
|
|
1279
|
+
- type: :string
|
|
1280
|
+
- configid:
|
|
1281
|
+
- desc: ''
|
|
1282
|
+
- required: true
|
|
1283
|
+
- type: :numeric
|
|
1284
|
+
- port:
|
|
1285
|
+
- desc: Port to bind to on the public interfaces. 1-65534
|
|
1286
|
+
- required: false
|
|
1287
|
+
- type: :numeric
|
|
1288
|
+
- protocol:
|
|
1289
|
+
- desc: Either 'tcp', 'http', or 'https'
|
|
1290
|
+
- required: false
|
|
1291
|
+
- type: :string
|
|
1292
|
+
- ssl_cert:
|
|
1293
|
+
- desc: SSL certificate served by the NodeBalancer when the protocol is 'https'
|
|
1294
|
+
- required: false
|
|
1295
|
+
- type: :string
|
|
1296
|
+
- ssl_key:
|
|
1297
|
+
- desc: Unpassphrased private key for the SSL certificate when protocol is
|
|
1298
|
+
'https'
|
|
1299
|
+
- required: false
|
|
1300
|
+
- type: :string
|
|
1301
|
+
- stickiness:
|
|
1302
|
+
- desc: Session persistence. One of 'none', 'table', 'http_cookie'
|
|
1303
|
+
- required: false
|
|
1304
|
+
- type: :string
|
|
1305
|
+
- throws:
|
|
1306
|
+
- NOTFOUND
|
|
1307
|
+
- VALIDATION
|
|
1308
|
+
create:
|
|
1309
|
+
- desc: ''
|
|
1310
|
+
- params:
|
|
1311
|
+
- clientconnthrottle:
|
|
1312
|
+
- desc: To help mitigate abuse, throttle connections per second, per client
|
|
1313
|
+
IP. 0 to disable. Max of 20.
|
|
1314
|
+
- required: false
|
|
1315
|
+
- type: :numeric
|
|
1316
|
+
- datacenterid:
|
|
1317
|
+
- desc: The DatacenterID from avail.datacenters() where you wish to place this
|
|
1318
|
+
new NodeBalancer
|
|
1319
|
+
- required: true
|
|
1320
|
+
- type: :numeric
|
|
1321
|
+
- label:
|
|
1322
|
+
- desc: This NodeBalancer's label
|
|
1323
|
+
- required: false
|
|
1324
|
+
- type: :string
|
|
1325
|
+
- throws:
|
|
1326
|
+
- NOACCESS
|
|
1327
|
+
- CCFAILED
|
|
1328
|
+
- VALIDATION
|
|
1329
|
+
delete:
|
|
1330
|
+
- desc: Immediately removes a NodeBalancer from your account and issues a pro-rated
|
|
1331
|
+
credit back to your account, if applicable.
|
|
1332
|
+
- params:
|
|
1333
|
+
- nodebalancerid:
|
|
1334
|
+
- desc: The NodeBalancerID to delete
|
|
1335
|
+
- required: true
|
|
1336
|
+
- type: :numeric
|
|
1337
|
+
- throws:
|
|
1338
|
+
- NOTFOUND
|
|
1339
|
+
list:
|
|
1340
|
+
- desc: Returns a list of NodeBalancers this user has access or delete to, including
|
|
1341
|
+
their properties
|
|
1342
|
+
- params:
|
|
1343
|
+
- nodebalancerid:
|
|
1344
|
+
- desc: Limits the list to the specified NodeBalancerID
|
|
1345
|
+
- required: false
|
|
1346
|
+
- type: :numeric
|
|
1347
|
+
- throws: []
|
|
1348
|
+
node:
|
|
1349
|
+
create:
|
|
1350
|
+
- desc: ''
|
|
1351
|
+
- params:
|
|
1352
|
+
- address:
|
|
1353
|
+
- desc: The address:port combination used to communicate with this Node
|
|
1354
|
+
- required: true
|
|
1355
|
+
- type: :string
|
|
1356
|
+
- configid:
|
|
1357
|
+
- desc: The parent ConfigID to attach this Node to
|
|
1358
|
+
- required: true
|
|
1359
|
+
- type: :numeric
|
|
1360
|
+
- label:
|
|
1361
|
+
- desc: This backend Node's label
|
|
1362
|
+
- required: true
|
|
1363
|
+
- type: :string
|
|
1364
|
+
- mode:
|
|
1365
|
+
- desc: The connections mode for this node. One of 'accept', 'reject', or
|
|
1366
|
+
'drain'
|
|
1367
|
+
- required: false
|
|
1368
|
+
- type: :string
|
|
1369
|
+
- weight:
|
|
1370
|
+
- desc: Load balancing weight, 1-255. Higher means more connections.
|
|
1371
|
+
- required: false
|
|
1372
|
+
- type: :numeric
|
|
1373
|
+
- throws:
|
|
1374
|
+
- NOTFOUND
|
|
1375
|
+
- VALIDATION
|
|
1376
|
+
delete:
|
|
1377
|
+
- desc: Deletes a Node from a NodeBalancer Config
|
|
1378
|
+
- params:
|
|
1379
|
+
- nodeid:
|
|
1380
|
+
- desc: The NodeID to delete
|
|
1381
|
+
- required: true
|
|
1382
|
+
- type: :numeric
|
|
1383
|
+
- throws:
|
|
1384
|
+
- NOTFOUND
|
|
1385
|
+
list:
|
|
1386
|
+
- desc: Returns a list of Nodes associated with a NodeBalancer Config
|
|
1387
|
+
- params:
|
|
1388
|
+
- configid:
|
|
1389
|
+
- desc: ''
|
|
1390
|
+
- required: true
|
|
1391
|
+
- type: :numeric
|
|
1392
|
+
- nodeid:
|
|
1393
|
+
- desc: Limits the list to the specified NodeID
|
|
1394
|
+
- required: false
|
|
1395
|
+
- type: :numeric
|
|
1396
|
+
- throws: []
|
|
1397
|
+
update:
|
|
1398
|
+
- desc: Updates a Node's properties
|
|
1399
|
+
- params:
|
|
1400
|
+
- address:
|
|
1401
|
+
- desc: The address:port combination used to communicate with this Node
|
|
1402
|
+
- required: false
|
|
1403
|
+
- type: :string
|
|
1404
|
+
- label:
|
|
1405
|
+
- desc: This backend Node's label
|
|
1406
|
+
- required: false
|
|
1407
|
+
- type: :string
|
|
1408
|
+
- mode:
|
|
1409
|
+
- desc: The connections mode for this node. One of 'accept', 'reject', or
|
|
1410
|
+
'drain'
|
|
1411
|
+
- required: false
|
|
1412
|
+
- type: :string
|
|
1413
|
+
- nodeid:
|
|
1414
|
+
- desc: ''
|
|
1415
|
+
- required: true
|
|
1416
|
+
- type: :numeric
|
|
1417
|
+
- weight:
|
|
1418
|
+
- desc: Load balancing weight, 1-255. Higher means more connections.
|
|
1419
|
+
- required: false
|
|
1420
|
+
- type: :numeric
|
|
1421
|
+
- throws:
|
|
1422
|
+
- NOTFOUND
|
|
1423
|
+
- VALIDATION
|
|
1424
|
+
update:
|
|
1425
|
+
- desc: Updates a NodeBalancer's properties
|
|
1426
|
+
- params:
|
|
1427
|
+
- clientconnthrottle:
|
|
1428
|
+
- desc: To help mitigate abuse, throttle connections per second, per client
|
|
1429
|
+
IP. 0 to disable. Max of 20.
|
|
1430
|
+
- required: false
|
|
1431
|
+
- type: :numeric
|
|
1432
|
+
- label:
|
|
1433
|
+
- desc: This NodeBalancer's label
|
|
1434
|
+
- required: false
|
|
1435
|
+
- type: :string
|
|
1436
|
+
- nodebalancerid:
|
|
1437
|
+
- desc: ''
|
|
1438
|
+
- required: true
|
|
1439
|
+
- type: :numeric
|
|
1440
|
+
- throws:
|
|
1441
|
+
- NOTFOUND
|
|
1442
|
+
- VALIDATION
|
|
1443
|
+
stackscript:
|
|
1444
|
+
create:
|
|
1445
|
+
- desc: Create a StackScript.
|
|
1446
|
+
- params:
|
|
1447
|
+
- description:
|
|
1448
|
+
- desc: ''
|
|
1449
|
+
- required: false
|
|
1450
|
+
- type: :string
|
|
1451
|
+
- distributionidlist:
|
|
1452
|
+
- desc: 'Comma delimited list of DistributionIDs that this script works on '
|
|
1453
|
+
- required: true
|
|
1454
|
+
- type: :string
|
|
1455
|
+
- ispublic:
|
|
1456
|
+
- desc: Whether this StackScript is published in the Library, for everyone to
|
|
1457
|
+
use
|
|
1458
|
+
- required: false
|
|
1459
|
+
- type: :boolean
|
|
1460
|
+
- label:
|
|
1461
|
+
- desc: The Label for this StackScript
|
|
1462
|
+
- required: true
|
|
1463
|
+
- type: :string
|
|
1464
|
+
- rev_note:
|
|
1465
|
+
- desc: ''
|
|
1466
|
+
- required: false
|
|
1467
|
+
- type: :string
|
|
1468
|
+
- script:
|
|
1469
|
+
- desc: The actual script
|
|
1470
|
+
- required: true
|
|
1471
|
+
- type: :string
|
|
1472
|
+
- throws:
|
|
1473
|
+
- NOACCESS
|
|
1474
|
+
- VALIDATION
|
|
1475
|
+
delete:
|
|
1476
|
+
- desc: ''
|
|
1477
|
+
- params:
|
|
1478
|
+
- stackscriptid:
|
|
1479
|
+
- desc: ''
|
|
1480
|
+
- required: true
|
|
1481
|
+
- type: :numeric
|
|
1482
|
+
- throws:
|
|
1483
|
+
- NOTFOUND
|
|
1484
|
+
list:
|
|
1485
|
+
- desc: Lists StackScripts you have access to.
|
|
1486
|
+
- params:
|
|
1487
|
+
- stackscriptid:
|
|
1488
|
+
- desc: Limits the list to the specified StackScriptID
|
|
1489
|
+
- required: false
|
|
1490
|
+
- type: :numeric
|
|
1491
|
+
- throws: []
|
|
1492
|
+
update:
|
|
1493
|
+
- desc: Update a StackScript.
|
|
1494
|
+
- params:
|
|
1495
|
+
- description:
|
|
1496
|
+
- desc: ''
|
|
1497
|
+
- required: false
|
|
1498
|
+
- type: :string
|
|
1499
|
+
- distributionidlist:
|
|
1500
|
+
- desc: 'Comma delimited list of DistributionIDs that this script works on '
|
|
1501
|
+
- required: false
|
|
1502
|
+
- type: :string
|
|
1503
|
+
- ispublic:
|
|
1504
|
+
- desc: Whether this StackScript is published in the Library, for everyone to
|
|
1505
|
+
use
|
|
1506
|
+
- required: false
|
|
1507
|
+
- type: :boolean
|
|
1508
|
+
- label:
|
|
1509
|
+
- desc: The Label for this StackScript
|
|
1510
|
+
- required: false
|
|
1511
|
+
- type: :string
|
|
1512
|
+
- rev_note:
|
|
1513
|
+
- desc: ''
|
|
1514
|
+
- required: false
|
|
1515
|
+
- type: :string
|
|
1516
|
+
- script:
|
|
1517
|
+
- desc: The actual script
|
|
1518
|
+
- required: false
|
|
1519
|
+
- type: :string
|
|
1520
|
+
- stackscriptid:
|
|
1521
|
+
- desc: ''
|
|
1522
|
+
- required: true
|
|
1523
|
+
- type: :numeric
|
|
1524
|
+
- throws:
|
|
1525
|
+
- NOTFOUND
|
|
1526
|
+
- VALIDATION
|
|
1527
|
+
test:
|
|
1528
|
+
echo:
|
|
1529
|
+
- desc: Echos back parameters that were passed in.
|
|
1530
|
+
- params: []
|
|
1531
|
+
- throws: []
|
|
1532
|
+
user:
|
|
1533
|
+
getapikey:
|
|
1534
|
+
- desc: Authenticates a Linode Manager user against their username, password, and
|
|
1535
|
+
two-factor token (when enabled), and then returns a new API key, which can be
|
|
1536
|
+
used until it expires. The number of active keys is limited to 20.
|
|
1537
|
+
- params:
|
|
1538
|
+
- expires:
|
|
1539
|
+
- desc: Number of hours the key will remain valid, between 0 and 8760. 0 means
|
|
1540
|
+
no expiration. Defaults to 168.
|
|
1541
|
+
- required: false
|
|
1542
|
+
- type: :numeric
|
|
1543
|
+
- label:
|
|
1544
|
+
- desc: An optional label for this key.
|
|
1545
|
+
- required: false
|
|
1546
|
+
- type: :string
|
|
1547
|
+
- password:
|
|
1548
|
+
- desc: ''
|
|
1549
|
+
- required: true
|
|
1550
|
+
- type: :string
|
|
1551
|
+
- token:
|
|
1552
|
+
- desc: Required when two-factor authentication is enabled.
|
|
1553
|
+
- required: false
|
|
1554
|
+
- type: :string
|
|
1555
|
+
- username:
|
|
1556
|
+
- desc: ''
|
|
1557
|
+
- required: true
|
|
1558
|
+
- type: :string
|
|
1559
|
+
- throws:
|
|
1560
|
+
- AUTHFAIL
|
|
1561
|
+
- " NEEDTOKEN"
|
|
1562
|
+
- " PASSWORDEXPIRED"
|
|
1563
|
+
- " KEYLIMIT"
|