@scaleway/sdk-baremetal 2.14.0 → 2.15.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.
@@ -1,4 +1,5 @@
1
- import type { Money, TimeSeries, Zone as ScwZone } from '@scaleway/sdk-client';
1
+ import { Money, TimeSeries, Zone } from "@scaleway/sdk-client";
2
+ //#region src/v1/types.gen.d.ts
2
3
  export type IPReverseStatus = 'unknown' | 'pending' | 'active' | 'error';
3
4
  export type IPVersion = 'IPv4' | 'IPv6';
4
5
  export type ListServerEventsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
@@ -20,1440 +21,1439 @@ export type ServerPrivateNetworkStatus = 'unknown' | 'attaching' | 'attached' |
20
21
  export type ServerStatus = 'unknown' | 'delivering' | 'ready' | 'stopping' | 'stopped' | 'starting' | 'error' | 'deleting' | 'locked' | 'out_of_stock' | 'ordered' | 'resetting' | 'migrating';
21
22
  export type SettingType = 'unknown' | 'smtp';
22
23
  export interface SchemaPartition {
23
- label: SchemaPartitionLabel;
24
- number: number;
25
- size: number;
26
- useAllAvailableSpace: boolean;
24
+ label: SchemaPartitionLabel;
25
+ number: number;
26
+ size: number;
27
+ useAllAvailableSpace: boolean;
27
28
  }
28
29
  export interface SchemaPool {
29
- name: string;
30
- type: SchemaPoolType;
31
- devices: string[];
32
- options: string[];
33
- filesystemOptions: string[];
30
+ name: string;
31
+ type: SchemaPoolType;
32
+ devices: string[];
33
+ options: string[];
34
+ filesystemOptions: string[];
34
35
  }
35
36
  export interface SchemaDisk {
36
- device: string;
37
- partitions: SchemaPartition[];
37
+ device: string;
38
+ partitions: SchemaPartition[];
38
39
  }
39
40
  export interface SchemaFilesystem {
40
- device: string;
41
- format: SchemaFilesystemFormat;
42
- mountpoint: string;
41
+ device: string;
42
+ format: SchemaFilesystemFormat;
43
+ mountpoint: string;
43
44
  }
44
45
  export interface SchemaRAID {
45
- name: string;
46
- level: SchemaRAIDLevel;
47
- devices: string[];
46
+ name: string;
47
+ level: SchemaRAIDLevel;
48
+ devices: string[];
48
49
  }
49
50
  export interface SchemaZFS {
50
- pools: SchemaPool[];
51
+ pools: SchemaPool[];
51
52
  }
52
53
  export interface Schema {
53
- disks: SchemaDisk[];
54
- raids: SchemaRAID[];
55
- filesystems: SchemaFilesystem[];
56
- zfs?: SchemaZFS;
57
- }
58
- export interface CertificationOption {
54
+ disks: SchemaDisk[];
55
+ raids: SchemaRAID[];
56
+ filesystems: SchemaFilesystem[];
57
+ zfs?: SchemaZFS;
59
58
  }
59
+ export interface CertificationOption {}
60
60
  export interface LicenseOption {
61
- osId: string;
61
+ osId: string;
62
62
  }
63
63
  export interface PrivateNetworkOption {
64
- bandwidthInBps: number;
64
+ bandwidthInBps: number;
65
65
  }
66
66
  export interface PublicBandwidthOption {
67
- bandwidthInBps: number;
68
- }
69
- export interface RemoteAccessOption {
67
+ bandwidthInBps: number;
70
68
  }
69
+ export interface RemoteAccessOption {}
71
70
  export interface CreateServerRequestInstall {
72
- /**
73
- * ID of the OS to installation on the server.
74
- */
75
- osId: string;
76
- /**
77
- * Hostname of the server.
78
- */
79
- hostname: string;
80
- /**
81
- * SSH key IDs authorized on the server.
82
- */
83
- sshKeyIds: string[];
84
- /**
85
- * User for the installation.
86
- */
87
- user?: string;
88
- /**
89
- * Password for the installation.
90
- */
91
- password?: string;
92
- /**
93
- * Regular user that runs the service to be installed on the server.
94
- */
95
- serviceUser?: string;
96
- /**
97
- * Password used for the service to install.
98
- */
99
- servicePassword?: string;
100
- /**
101
- * Partitioning schema.
102
- */
103
- partitioningSchema?: Schema;
71
+ /**
72
+ * ID of the OS to installation on the server.
73
+ */
74
+ osId: string;
75
+ /**
76
+ * Hostname of the server.
77
+ */
78
+ hostname: string;
79
+ /**
80
+ * SSH key IDs authorized on the server.
81
+ */
82
+ sshKeyIds: string[];
83
+ /**
84
+ * User for the installation.
85
+ */
86
+ user?: string;
87
+ /**
88
+ * Password for the installation.
89
+ */
90
+ password?: string;
91
+ /**
92
+ * Regular user that runs the service to be installed on the server.
93
+ */
94
+ serviceUser?: string;
95
+ /**
96
+ * Password used for the service to install.
97
+ */
98
+ servicePassword?: string;
99
+ /**
100
+ * Partitioning schema.
101
+ */
102
+ partitioningSchema?: Schema;
104
103
  }
105
104
  export interface IP {
106
- /**
107
- * ID of the IP.
108
- */
109
- id: string;
110
- /**
111
- * Address of the IP.
112
- */
113
- address: string;
114
- /**
115
- * Reverse IP value.
116
- */
117
- reverse: string;
118
- /**
119
- * Version of IP (v4 or v6).
120
- */
121
- version: IPVersion;
122
- /**
123
- * Status of the reverse.
124
- */
125
- reverseStatus: IPReverseStatus;
126
- /**
127
- * A message related to the reverse status, e.g. in case of an error.
128
- */
129
- reverseStatusMessage: string;
105
+ /**
106
+ * ID of the IP.
107
+ */
108
+ id: string;
109
+ /**
110
+ * Address of the IP.
111
+ */
112
+ address: string;
113
+ /**
114
+ * Reverse IP value.
115
+ */
116
+ reverse: string;
117
+ /**
118
+ * Version of IP (v4 or v6).
119
+ */
120
+ version: IPVersion;
121
+ /**
122
+ * Status of the reverse.
123
+ */
124
+ reverseStatus: IPReverseStatus;
125
+ /**
126
+ * A message related to the reverse status, e.g. in case of an error.
127
+ */
128
+ reverseStatusMessage: string;
130
129
  }
131
130
  export interface ServerInstall {
132
- /**
133
- * ID of the OS.
134
- */
135
- osId: string;
136
- /**
137
- * Host defined during the server installation.
138
- */
139
- hostname: string;
140
- /**
141
- * SSH public key IDs defined during server installation.
142
- */
143
- sshKeyIds: string[];
144
- /**
145
- * Status of the server installation.
146
- */
147
- status: ServerInstallStatus;
148
- /**
149
- * User defined in the server installation, or the default user if none were specified.
150
- */
151
- user: string;
152
- /**
153
- * Service user defined in the server installation, or the default user if none were specified.
154
- */
155
- serviceUser: string;
156
- /**
157
- * Address of the installed service.
158
- */
159
- serviceUrl: string;
160
- /**
161
- * Partitioning schema.
162
- */
163
- partitioningSchema?: Schema;
131
+ /**
132
+ * ID of the OS.
133
+ */
134
+ osId: string;
135
+ /**
136
+ * Host defined during the server installation.
137
+ */
138
+ hostname: string;
139
+ /**
140
+ * SSH public key IDs defined during server installation.
141
+ */
142
+ sshKeyIds: string[];
143
+ /**
144
+ * Status of the server installation.
145
+ */
146
+ status: ServerInstallStatus;
147
+ /**
148
+ * User defined in the server installation, or the default user if none were specified.
149
+ */
150
+ user: string;
151
+ /**
152
+ * Service user defined in the server installation, or the default user if none were specified.
153
+ */
154
+ serviceUser: string;
155
+ /**
156
+ * Address of the installed service.
157
+ */
158
+ serviceUrl: string;
159
+ /**
160
+ * Partitioning schema.
161
+ */
162
+ partitioningSchema?: Schema;
164
163
  }
165
164
  export interface ServerOption {
166
- /**
167
- * ID of the option.
168
- */
169
- id: string;
170
- /**
171
- * Name of the option.
172
- */
173
- name: string;
174
- /**
175
- * Status of the option on this server.
176
- */
177
- status: ServerOptionOptionStatus;
178
- /**
179
- * Defines whether the option can be managed (added or removed).
180
- */
181
- manageable: boolean;
182
- /**
183
- * Auto expiration date for compatible options.
184
- */
185
- expiresAt?: Date;
186
- /**
187
- * License option, contains the ID of the OS linked to the option.
188
- *
189
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
190
- */
191
- license?: LicenseOption;
192
- /**
193
- * Public_bandwidth option, contains the bandwidth_in_bps.
194
- *
195
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
196
- */
197
- publicBandwidth?: PublicBandwidthOption;
198
- /**
199
- * Private_network option, contains the bandwidth_in_bps.
200
- *
201
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
202
- */
203
- privateNetwork?: PrivateNetworkOption;
204
- /**
205
- * Remote_access option.
206
- *
207
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
208
- */
209
- remoteAccess?: RemoteAccessOption;
210
- /**
211
- * Certification option.
212
- *
213
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
214
- */
215
- certification?: CertificationOption;
165
+ /**
166
+ * ID of the option.
167
+ */
168
+ id: string;
169
+ /**
170
+ * Name of the option.
171
+ */
172
+ name: string;
173
+ /**
174
+ * Status of the option on this server.
175
+ */
176
+ status: ServerOptionOptionStatus;
177
+ /**
178
+ * Defines whether the option can be managed (added or removed).
179
+ */
180
+ manageable: boolean;
181
+ /**
182
+ * Auto expiration date for compatible options.
183
+ */
184
+ expiresAt?: Date;
185
+ /**
186
+ * License option, contains the ID of the OS linked to the option.
187
+ *
188
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
189
+ */
190
+ license?: LicenseOption;
191
+ /**
192
+ * Public_bandwidth option, contains the bandwidth_in_bps.
193
+ *
194
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
195
+ */
196
+ publicBandwidth?: PublicBandwidthOption;
197
+ /**
198
+ * Private_network option, contains the bandwidth_in_bps.
199
+ *
200
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
201
+ */
202
+ privateNetwork?: PrivateNetworkOption;
203
+ /**
204
+ * Remote_access option.
205
+ *
206
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
207
+ */
208
+ remoteAccess?: RemoteAccessOption;
209
+ /**
210
+ * Certification option.
211
+ *
212
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
213
+ */
214
+ certification?: CertificationOption;
216
215
  }
217
216
  export interface ServerRescueServer {
218
- /**
219
- * Rescue user name.
220
- */
221
- user: string;
222
- /**
223
- * Rescue password.
224
- */
225
- password: string;
217
+ /**
218
+ * Rescue user name.
219
+ */
220
+ user: string;
221
+ /**
222
+ * Rescue password.
223
+ */
224
+ password: string;
226
225
  }
227
226
  export interface OSOSField {
228
- editable: boolean;
229
- required: boolean;
230
- defaultValue?: string;
227
+ editable: boolean;
228
+ required: boolean;
229
+ defaultValue?: string;
231
230
  }
232
231
  export interface CPU {
233
- /**
234
- * Name of the CPU.
235
- */
236
- name: string;
237
- /**
238
- * Number of CPU cores.
239
- */
240
- coreCount: number;
241
- /**
242
- * Number CPU threads.
243
- */
244
- threadCount: number;
245
- /**
246
- * Frequency of the CPU in MHz.
247
- */
248
- frequency: number;
249
- /**
250
- * Benchmark of the CPU.
251
- */
252
- benchmark: string;
232
+ /**
233
+ * Name of the CPU.
234
+ */
235
+ name: string;
236
+ /**
237
+ * Number of CPU cores.
238
+ */
239
+ coreCount: number;
240
+ /**
241
+ * Number CPU threads.
242
+ */
243
+ threadCount: number;
244
+ /**
245
+ * Frequency of the CPU in MHz.
246
+ */
247
+ frequency: number;
248
+ /**
249
+ * Benchmark of the CPU.
250
+ */
251
+ benchmark: string;
253
252
  }
254
253
  export interface Disk {
255
- /**
256
- * Capacity of the disk in bytes.
257
- */
258
- capacity: number;
259
- /**
260
- * Type of the disk.
261
- */
262
- type: string;
254
+ /**
255
+ * Capacity of the disk in bytes.
256
+ */
257
+ capacity: number;
258
+ /**
259
+ * Type of the disk.
260
+ */
261
+ type: string;
263
262
  }
264
263
  export interface GPU {
265
- /**
266
- * Name of the GPU.
267
- */
268
- name: string;
269
- /**
270
- * Capacity of the vram in bytes.
271
- */
272
- vram: number;
264
+ /**
265
+ * Name of the GPU.
266
+ */
267
+ name: string;
268
+ /**
269
+ * Capacity of the vram in bytes.
270
+ */
271
+ vram: number;
273
272
  }
274
273
  export interface Memory {
275
- /**
276
- * Capacity of the memory in bytes.
277
- */
278
- capacity: number;
279
- /**
280
- * Type of the memory.
281
- */
282
- type: string;
283
- /**
284
- * Frequency of the memory in MHz.
285
- */
286
- frequency: number;
287
- /**
288
- * True if the memory is an error-correcting code memory.
289
- */
290
- isEcc: boolean;
291
- /**
292
- * Type of ECC memory.
293
- */
294
- eccType: MemoryEccType;
274
+ /**
275
+ * Capacity of the memory in bytes.
276
+ */
277
+ capacity: number;
278
+ /**
279
+ * Type of the memory.
280
+ */
281
+ type: string;
282
+ /**
283
+ * Frequency of the memory in MHz.
284
+ */
285
+ frequency: number;
286
+ /**
287
+ * True if the memory is an error-correcting code memory.
288
+ */
289
+ isEcc: boolean;
290
+ /**
291
+ * Type of ECC memory.
292
+ */
293
+ eccType: MemoryEccType;
295
294
  }
296
295
  export interface OfferOptionOffer {
297
- /**
298
- * ID of the option.
299
- */
300
- id: string;
301
- /**
302
- * Name of the option.
303
- */
304
- name: string;
305
- /**
296
+ /**
297
+ * ID of the option.
298
+ */
299
+ id: string;
300
+ /**
301
+ * Name of the option.
302
+ */
303
+ name: string;
304
+ /**
306
305
  * If true the option is enabled and included by default in the offer
307
306
  If false the option is available for the offer but not included by default.
308
307
  */
309
- enabled: boolean;
310
- /**
311
- * Period of subscription for the offer.
312
- */
313
- subscriptionPeriod: OfferSubscriptionPeriod;
314
- /**
315
- * Price of the option.
316
- */
317
- price?: Money;
318
- /**
319
- * Boolean to know if option could be managed.
320
- */
321
- manageable: boolean;
322
- /**
323
- * @deprecated Deprecated, use LicenseOptionVars.os_id instead.
324
- */
325
- osId?: string;
326
- /**
327
- * License option, contains the ID of the OS linked to the option.
328
- *
329
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
330
- */
331
- license?: LicenseOption;
332
- /**
333
- * Public_bandwidth option, contains the bandwidth_in_bps.
334
- *
335
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
336
- */
337
- publicBandwidth?: PublicBandwidthOption;
338
- /**
339
- * Private_network option, contains the bandwidth_in_bps.
340
- *
341
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
342
- */
343
- privateNetwork?: PrivateNetworkOption;
344
- /**
345
- * Remote_access option.
346
- *
347
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
348
- */
349
- remoteAccess?: RemoteAccessOption;
350
- /**
351
- * Certification option.
352
- *
353
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
354
- */
355
- certification?: CertificationOption;
308
+ enabled: boolean;
309
+ /**
310
+ * Period of subscription for the offer.
311
+ */
312
+ subscriptionPeriod: OfferSubscriptionPeriod;
313
+ /**
314
+ * Price of the option.
315
+ */
316
+ price?: Money;
317
+ /**
318
+ * Boolean to know if option could be managed.
319
+ */
320
+ manageable: boolean;
321
+ /**
322
+ * @deprecated Deprecated, use LicenseOptionVars.os_id instead.
323
+ */
324
+ osId?: string;
325
+ /**
326
+ * License option, contains the ID of the OS linked to the option.
327
+ *
328
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
329
+ */
330
+ license?: LicenseOption;
331
+ /**
332
+ * Public_bandwidth option, contains the bandwidth_in_bps.
333
+ *
334
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
335
+ */
336
+ publicBandwidth?: PublicBandwidthOption;
337
+ /**
338
+ * Private_network option, contains the bandwidth_in_bps.
339
+ *
340
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
341
+ */
342
+ privateNetwork?: PrivateNetworkOption;
343
+ /**
344
+ * Remote_access option.
345
+ *
346
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
347
+ */
348
+ remoteAccess?: RemoteAccessOption;
349
+ /**
350
+ * Certification option.
351
+ *
352
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
353
+ */
354
+ certification?: CertificationOption;
356
355
  }
357
356
  export interface PersistentMemory {
358
- /**
359
- * Capacity of the memory in bytes.
360
- */
361
- capacity: number;
362
- /**
363
- * Type of the memory.
364
- */
365
- type: string;
366
- /**
367
- * Frequency of the memory in MHz.
368
- */
369
- frequency: number;
357
+ /**
358
+ * Capacity of the memory in bytes.
359
+ */
360
+ capacity: number;
361
+ /**
362
+ * Type of the memory.
363
+ */
364
+ type: string;
365
+ /**
366
+ * Frequency of the memory in MHz.
367
+ */
368
+ frequency: number;
370
369
  }
371
370
  export interface RaidController {
372
- model: string;
373
- raidLevel: string[];
371
+ model: string;
372
+ raidLevel: string[];
374
373
  }
375
374
  export interface BatchCreateServersRequestServerConfig {
376
- hostname: string;
377
- description: string;
378
- tags: string[];
375
+ hostname: string;
376
+ description: string;
377
+ tags: string[];
379
378
  }
380
379
  export type CreateServerRequest = {
381
- /**
382
- * Zone to target. If none is passed will use default zone from the config.
383
- */
384
- zone?: ScwZone;
385
- /**
386
- * Offer ID of the new server.
387
- */
388
- offerId: string;
389
- /**
390
- * @deprecated Organization ID with which the server will be created.
391
- *
392
- * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
393
- */
394
- organizationId?: string;
395
- /**
396
- * Project ID with which the server will be created.
397
- *
398
- * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
399
- */
400
- projectId?: string;
401
- /**
402
- * Name of the server (≠hostname).
403
- */
404
- name: string;
405
- /**
406
- * Description associated with the server, max 255 characters.
407
- */
408
- description: string;
409
- /**
410
- * Tags to associate to the server.
411
- */
412
- tags?: string[];
413
- /**
414
- * Object describing the configuration details of the OS installation on the server.
415
- */
416
- install?: CreateServerRequestInstall;
417
- /**
418
- * IDs of options to enable on server.
419
- */
420
- optionIds?: string[];
421
- /**
422
- * If enabled, the server can not be deleted.
423
- */
424
- protected: boolean;
425
- /**
426
- * Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.
427
- */
428
- userData?: string;
380
+ /**
381
+ * Zone to target. If none is passed will use default zone from the config.
382
+ */
383
+ zone?: Zone;
384
+ /**
385
+ * Offer ID of the new server.
386
+ */
387
+ offerId: string;
388
+ /**
389
+ * @deprecated Organization ID with which the server will be created.
390
+ *
391
+ * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
392
+ */
393
+ organizationId?: string;
394
+ /**
395
+ * Project ID with which the server will be created.
396
+ *
397
+ * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
398
+ */
399
+ projectId?: string;
400
+ /**
401
+ * Name of the server (≠hostname).
402
+ */
403
+ name: string;
404
+ /**
405
+ * Description associated with the server, max 255 characters.
406
+ */
407
+ description: string;
408
+ /**
409
+ * Tags to associate to the server.
410
+ */
411
+ tags?: string[];
412
+ /**
413
+ * Object describing the configuration details of the OS installation on the server.
414
+ */
415
+ install?: CreateServerRequestInstall;
416
+ /**
417
+ * IDs of options to enable on server.
418
+ */
419
+ optionIds?: string[];
420
+ /**
421
+ * If enabled, the server can not be deleted.
422
+ */
423
+ protected: boolean;
424
+ /**
425
+ * Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.
426
+ */
427
+ userData?: string;
429
428
  };
430
429
  export interface Server {
431
- /**
432
- * ID of the server.
433
- */
434
- id: string;
435
- /**
436
- * Organization ID the server is attached to.
437
- */
438
- organizationId: string;
439
- /**
440
- * Project ID the server is attached to.
441
- */
442
- projectId: string;
443
- /**
444
- * Name of the server.
445
- */
446
- name: string;
447
- /**
448
- * Description of the server.
449
- */
450
- description: string;
451
- /**
452
- * Last modification date of the server.
453
- */
454
- updatedAt?: Date;
455
- /**
456
- * Creation date of the server.
457
- */
458
- createdAt?: Date;
459
- /**
460
- * Status of the server.
461
- */
462
- status: ServerStatus;
463
- /**
464
- * Offer ID of the server.
465
- */
466
- offerId: string;
467
- /**
468
- * Offer name of the server.
469
- */
470
- offerName: string;
471
- /**
472
- * Array of custom tags attached to the server.
473
- */
474
- tags: string[];
475
- /**
476
- * Array of IPs attached to the server.
477
- */
478
- ips: IP[];
479
- /**
480
- * Domain of the server.
481
- */
482
- domain: string;
483
- /**
484
- * Boot type of the server.
485
- */
486
- bootType: ServerBootType;
487
- /**
488
- * Zone in which is the server located.
489
- */
490
- zone: ScwZone;
491
- /**
492
- * Configuration of the installation.
493
- */
494
- install?: ServerInstall;
495
- /**
496
- * Status of server ping.
497
- */
498
- pingStatus: ServerPingStatus;
499
- /**
500
- * Options enabled on the server.
501
- */
502
- options: ServerOption[];
503
- /**
504
- * Configuration of rescue boot.
505
- */
506
- rescueServer?: ServerRescueServer;
507
- /**
508
- * If enabled, the server can not be deleted.
509
- */
510
- protected: boolean;
511
- /**
512
- * Optional configuration data passed to cloud-init.
513
- */
514
- userData?: string;
430
+ /**
431
+ * ID of the server.
432
+ */
433
+ id: string;
434
+ /**
435
+ * Organization ID the server is attached to.
436
+ */
437
+ organizationId: string;
438
+ /**
439
+ * Project ID the server is attached to.
440
+ */
441
+ projectId: string;
442
+ /**
443
+ * Name of the server.
444
+ */
445
+ name: string;
446
+ /**
447
+ * Description of the server.
448
+ */
449
+ description: string;
450
+ /**
451
+ * Last modification date of the server.
452
+ */
453
+ updatedAt?: Date;
454
+ /**
455
+ * Creation date of the server.
456
+ */
457
+ createdAt?: Date;
458
+ /**
459
+ * Status of the server.
460
+ */
461
+ status: ServerStatus;
462
+ /**
463
+ * Offer ID of the server.
464
+ */
465
+ offerId: string;
466
+ /**
467
+ * Offer name of the server.
468
+ */
469
+ offerName: string;
470
+ /**
471
+ * Array of custom tags attached to the server.
472
+ */
473
+ tags: string[];
474
+ /**
475
+ * Array of IPs attached to the server.
476
+ */
477
+ ips: IP[];
478
+ /**
479
+ * Domain of the server.
480
+ */
481
+ domain: string;
482
+ /**
483
+ * Boot type of the server.
484
+ */
485
+ bootType: ServerBootType;
486
+ /**
487
+ * Zone in which is the server located.
488
+ */
489
+ zone: Zone;
490
+ /**
491
+ * Configuration of the installation.
492
+ */
493
+ install?: ServerInstall;
494
+ /**
495
+ * Status of server ping.
496
+ */
497
+ pingStatus: ServerPingStatus;
498
+ /**
499
+ * Options enabled on the server.
500
+ */
501
+ options: ServerOption[];
502
+ /**
503
+ * Configuration of rescue boot.
504
+ */
505
+ rescueServer?: ServerRescueServer;
506
+ /**
507
+ * If enabled, the server can not be deleted.
508
+ */
509
+ protected: boolean;
510
+ /**
511
+ * Optional configuration data passed to cloud-init.
512
+ */
513
+ userData?: string;
515
514
  }
516
515
  export interface OS {
517
- /**
518
- * ID of the OS.
519
- */
520
- id: string;
521
- /**
522
- * Name of the OS.
523
- */
524
- name: string;
525
- /**
526
- * Version of the OS.
527
- */
528
- version: string;
529
- /**
530
- * URL of this OS's logo.
531
- */
532
- logoUrl: string;
533
- /**
534
- * Object defining the SSH requirements to install the OS.
535
- */
536
- ssh?: OSOSField;
537
- /**
538
- * Object defining the username requirements to install the OS.
539
- */
540
- user?: OSOSField;
541
- /**
542
- * Object defining the password requirements to install the OS.
543
- */
544
- password?: OSOSField;
545
- /**
546
- * Object defining the username requirements to install the service.
547
- */
548
- serviceUser?: OSOSField;
549
- /**
550
- * Object defining the password requirements to install the service.
551
- */
552
- servicePassword?: OSOSField;
553
- /**
554
- * Defines if the operating system is enabled or not.
555
- */
556
- enabled: boolean;
557
- /**
558
- * License required (check server options for pricing details).
559
- */
560
- licenseRequired: boolean;
561
- /**
562
- * Defines if a specific Organization is allowed to install this OS type.
563
- */
564
- allowed: boolean;
565
- /**
566
- * Defines if custom partitioning is supported by this OS.
567
- */
568
- customPartitioningSupported: boolean;
569
- /**
570
- * Defines if cloud-init is supported by this OS.
571
- */
572
- cloudInitSupported: boolean;
573
- /**
574
- * Defines the cloud-init API version used by this OS.
575
- */
576
- cloudInitVersion?: string;
577
- /**
578
- * Zone in which is the OS is available.
579
- */
580
- zone: ScwZone;
516
+ /**
517
+ * ID of the OS.
518
+ */
519
+ id: string;
520
+ /**
521
+ * Name of the OS.
522
+ */
523
+ name: string;
524
+ /**
525
+ * Version of the OS.
526
+ */
527
+ version: string;
528
+ /**
529
+ * URL of this OS's logo.
530
+ */
531
+ logoUrl: string;
532
+ /**
533
+ * Object defining the SSH requirements to install the OS.
534
+ */
535
+ ssh?: OSOSField;
536
+ /**
537
+ * Object defining the username requirements to install the OS.
538
+ */
539
+ user?: OSOSField;
540
+ /**
541
+ * Object defining the password requirements to install the OS.
542
+ */
543
+ password?: OSOSField;
544
+ /**
545
+ * Object defining the username requirements to install the service.
546
+ */
547
+ serviceUser?: OSOSField;
548
+ /**
549
+ * Object defining the password requirements to install the service.
550
+ */
551
+ servicePassword?: OSOSField;
552
+ /**
553
+ * Defines if the operating system is enabled or not.
554
+ */
555
+ enabled: boolean;
556
+ /**
557
+ * License required (check server options for pricing details).
558
+ */
559
+ licenseRequired: boolean;
560
+ /**
561
+ * Defines if a specific Organization is allowed to install this OS type.
562
+ */
563
+ allowed: boolean;
564
+ /**
565
+ * Defines if custom partitioning is supported by this OS.
566
+ */
567
+ customPartitioningSupported: boolean;
568
+ /**
569
+ * Defines if cloud-init is supported by this OS.
570
+ */
571
+ cloudInitSupported: boolean;
572
+ /**
573
+ * Defines the cloud-init API version used by this OS.
574
+ */
575
+ cloudInitVersion?: string;
576
+ /**
577
+ * Zone in which is the OS is available.
578
+ */
579
+ zone: Zone;
581
580
  }
582
581
  export interface Offer {
583
- /**
584
- * ID of the offer.
585
- */
586
- id: string;
587
- /**
588
- * Name of the offer.
589
- */
590
- name: string;
591
- /**
592
- * Stock level.
593
- */
594
- stock: OfferStock;
595
- /**
596
- * Public bandwidth available (in bits/s) with the offer.
597
- */
598
- bandwidth: number;
599
- /**
600
- * Maximum public bandwidth available (in bits/s) depending on available options.
601
- */
602
- maxBandwidth: number;
603
- /**
604
- * Commercial range of the offer.
605
- */
606
- commercialRange: string;
607
- /**
608
- * Price of the offer for the next 60 minutes (a server order at 11h32 will be paid until 12h32).
609
- */
610
- pricePerHour?: Money;
611
- /**
612
- * Monthly price of the offer, if subscribing on a monthly basis.
613
- */
614
- pricePerMonth?: Money;
615
- /**
616
- * Disks specifications of the offer.
617
- */
618
- disks: Disk[];
619
- /**
620
- * Defines whether the offer is currently available.
621
- */
622
- enable: boolean;
623
- /**
624
- * CPU specifications of the offer.
625
- */
626
- cpus: CPU[];
627
- /**
628
- * Memory specifications of the offer.
629
- */
630
- memories: Memory[];
631
- /**
632
- * Name of the quota associated to the offer.
633
- */
634
- quotaName: string;
635
- /**
636
- * Persistent memory specifications of the offer.
637
- */
638
- persistentMemories: PersistentMemory[];
639
- /**
640
- * Raid controller specifications of the offer.
641
- */
642
- raidControllers: RaidController[];
643
- /**
644
- * Array of OS images IDs incompatible with the server.
645
- */
646
- incompatibleOsIds: string[];
647
- /**
648
- * Period of subscription for the offer.
649
- */
650
- subscriptionPeriod: OfferSubscriptionPeriod;
651
- /**
652
- * Operation path of the service.
653
- */
654
- operationPath: string;
655
- /**
656
- * One time fee invoiced by Scaleway for the setup and activation of the server.
657
- */
658
- fee?: Money;
659
- /**
660
- * Available options for customization of the server.
661
- */
662
- options: OfferOptionOffer[];
663
- /**
664
- * Private bandwidth available in bits/s with the offer.
665
- */
666
- privateBandwidth: number;
667
- /**
668
- * Defines whether the offer's bandwidth is shared or not.
669
- */
670
- sharedBandwidth: boolean;
671
- /**
672
- * Array of tags attached to the offer.
673
- */
674
- tags: string[];
675
- /**
676
- * GPU specifications of the offer.
677
- */
678
- gpus: GPU[];
679
- /**
680
- * Exist only for hourly offers, to migrate to the monthly offer.
681
- */
682
- monthlyOfferId?: string;
683
- /**
684
- * Zone in which is the offer is available.
685
- */
686
- zone: ScwZone;
687
- /**
688
- * Describe the network topology of the offer.
689
- */
690
- dualAttach?: boolean;
582
+ /**
583
+ * ID of the offer.
584
+ */
585
+ id: string;
586
+ /**
587
+ * Name of the offer.
588
+ */
589
+ name: string;
590
+ /**
591
+ * Stock level.
592
+ */
593
+ stock: OfferStock;
594
+ /**
595
+ * Public bandwidth available (in bits/s) with the offer.
596
+ */
597
+ bandwidth: number;
598
+ /**
599
+ * Maximum public bandwidth available (in bits/s) depending on available options.
600
+ */
601
+ maxBandwidth: number;
602
+ /**
603
+ * Commercial range of the offer.
604
+ */
605
+ commercialRange: string;
606
+ /**
607
+ * Price of the offer for the next 60 minutes (a server order at 11h32 will be paid until 12h32).
608
+ */
609
+ pricePerHour?: Money;
610
+ /**
611
+ * Monthly price of the offer, if subscribing on a monthly basis.
612
+ */
613
+ pricePerMonth?: Money;
614
+ /**
615
+ * Disks specifications of the offer.
616
+ */
617
+ disks: Disk[];
618
+ /**
619
+ * Defines whether the offer is currently available.
620
+ */
621
+ enable: boolean;
622
+ /**
623
+ * CPU specifications of the offer.
624
+ */
625
+ cpus: CPU[];
626
+ /**
627
+ * Memory specifications of the offer.
628
+ */
629
+ memories: Memory[];
630
+ /**
631
+ * Name of the quota associated to the offer.
632
+ */
633
+ quotaName: string;
634
+ /**
635
+ * Persistent memory specifications of the offer.
636
+ */
637
+ persistentMemories: PersistentMemory[];
638
+ /**
639
+ * Raid controller specifications of the offer.
640
+ */
641
+ raidControllers: RaidController[];
642
+ /**
643
+ * Array of OS images IDs incompatible with the server.
644
+ */
645
+ incompatibleOsIds: string[];
646
+ /**
647
+ * Period of subscription for the offer.
648
+ */
649
+ subscriptionPeriod: OfferSubscriptionPeriod;
650
+ /**
651
+ * Operation path of the service.
652
+ */
653
+ operationPath: string;
654
+ /**
655
+ * One time fee invoiced by Scaleway for the setup and activation of the server.
656
+ */
657
+ fee?: Money;
658
+ /**
659
+ * Available options for customization of the server.
660
+ */
661
+ options: OfferOptionOffer[];
662
+ /**
663
+ * Private bandwidth available in bits/s with the offer.
664
+ */
665
+ privateBandwidth: number;
666
+ /**
667
+ * Defines whether the offer's bandwidth is shared or not.
668
+ */
669
+ sharedBandwidth: boolean;
670
+ /**
671
+ * Array of tags attached to the offer.
672
+ */
673
+ tags: string[];
674
+ /**
675
+ * GPU specifications of the offer.
676
+ */
677
+ gpus: GPU[];
678
+ /**
679
+ * Exist only for hourly offers, to migrate to the monthly offer.
680
+ */
681
+ monthlyOfferId?: string;
682
+ /**
683
+ * Zone in which is the offer is available.
684
+ */
685
+ zone: Zone;
686
+ /**
687
+ * Describe the network topology of the offer.
688
+ */
689
+ dualAttach?: boolean;
691
690
  }
692
691
  export interface Option {
693
- /**
694
- * ID of the option.
695
- */
696
- id: string;
697
- /**
698
- * Name of the option.
699
- */
700
- name: string;
701
- /**
702
- * Defines whether the option is manageable (could be added or removed).
703
- */
704
- manageable: boolean;
705
- /**
706
- * License option, contains the ID of the OS linked to the option.
707
- *
708
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
709
- */
710
- license?: LicenseOption;
711
- /**
712
- * Public_bandwidth option, contains the bandwidth_in_bps.
713
- *
714
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
715
- */
716
- publicBandwidth?: PublicBandwidthOption;
717
- /**
718
- * Private_network option, contains the bandwidth_in_bps.
719
- *
720
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
721
- */
722
- privateNetwork?: PrivateNetworkOption;
723
- /**
724
- * Remote_access option.
725
- *
726
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
727
- */
728
- remoteAccess?: RemoteAccessOption;
729
- /**
730
- * Certification option.
731
- *
732
- * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
733
- */
734
- certification?: CertificationOption;
692
+ /**
693
+ * ID of the option.
694
+ */
695
+ id: string;
696
+ /**
697
+ * Name of the option.
698
+ */
699
+ name: string;
700
+ /**
701
+ * Defines whether the option is manageable (could be added or removed).
702
+ */
703
+ manageable: boolean;
704
+ /**
705
+ * License option, contains the ID of the OS linked to the option.
706
+ *
707
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
708
+ */
709
+ license?: LicenseOption;
710
+ /**
711
+ * Public_bandwidth option, contains the bandwidth_in_bps.
712
+ *
713
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
714
+ */
715
+ publicBandwidth?: PublicBandwidthOption;
716
+ /**
717
+ * Private_network option, contains the bandwidth_in_bps.
718
+ *
719
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
720
+ */
721
+ privateNetwork?: PrivateNetworkOption;
722
+ /**
723
+ * Remote_access option.
724
+ *
725
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
726
+ */
727
+ remoteAccess?: RemoteAccessOption;
728
+ /**
729
+ * Certification option.
730
+ *
731
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
732
+ */
733
+ certification?: CertificationOption;
735
734
  }
736
735
  export interface ServerEvent {
737
- /**
738
- * ID of the server to which the action will be applied.
739
- */
740
- id: string;
741
- /**
742
- * The action that will be applied to the server.
743
- */
744
- action: string;
745
- /**
746
- * Date of last modification of the action.
747
- */
748
- updatedAt?: Date;
749
- /**
750
- * Date of creation of the action.
751
- */
752
- createdAt?: Date;
736
+ /**
737
+ * ID of the server to which the action will be applied.
738
+ */
739
+ id: string;
740
+ /**
741
+ * The action that will be applied to the server.
742
+ */
743
+ action: string;
744
+ /**
745
+ * Date of last modification of the action.
746
+ */
747
+ updatedAt?: Date;
748
+ /**
749
+ * Date of creation of the action.
750
+ */
751
+ createdAt?: Date;
753
752
  }
754
753
  export interface ServerPrivateNetwork {
755
- /**
756
- * The Private Network ID.
757
- */
758
- id: string;
759
- /**
760
- * The Private Network Project ID.
761
- */
762
- projectId: string;
763
- /**
764
- * The server ID.
765
- */
766
- serverId: string;
767
- /**
768
- * The Private Network ID.
769
- */
770
- privateNetworkId: string;
771
- /**
772
- * The VLAN ID associated to the Private Network.
773
- */
774
- vlan?: number;
775
- /**
776
- * The configuration status of the Private Network.
777
- */
778
- status: ServerPrivateNetworkStatus;
779
- /**
780
- * The Private Network creation date.
781
- */
782
- createdAt?: Date;
783
- /**
784
- * The date the Private Network was last modified.
785
- */
786
- updatedAt?: Date;
754
+ /**
755
+ * The Private Network ID.
756
+ */
757
+ id: string;
758
+ /**
759
+ * The Private Network Project ID.
760
+ */
761
+ projectId: string;
762
+ /**
763
+ * The server ID.
764
+ */
765
+ serverId: string;
766
+ /**
767
+ * The Private Network ID.
768
+ */
769
+ privateNetworkId: string;
770
+ /**
771
+ * The VLAN ID associated to the Private Network.
772
+ */
773
+ vlan?: number;
774
+ /**
775
+ * The configuration status of the Private Network.
776
+ */
777
+ status: ServerPrivateNetworkStatus;
778
+ /**
779
+ * The Private Network creation date.
780
+ */
781
+ createdAt?: Date;
782
+ /**
783
+ * The date the Private Network was last modified.
784
+ */
785
+ updatedAt?: Date;
787
786
  }
788
787
  export interface Setting {
789
- /**
790
- * ID of the setting.
791
- */
792
- id: string;
793
- /**
794
- * Type of the setting.
795
- */
796
- type: SettingType;
797
- /**
798
- * ID of the Project ID.
799
- */
800
- projectId: string;
801
- /**
802
- * Defines whether the setting is enabled.
803
- */
804
- enabled: boolean;
788
+ /**
789
+ * ID of the setting.
790
+ */
791
+ id: string;
792
+ /**
793
+ * Type of the setting.
794
+ */
795
+ type: SettingType;
796
+ /**
797
+ * ID of the Project ID.
798
+ */
799
+ projectId: string;
800
+ /**
801
+ * Defines whether the setting is enabled.
802
+ */
803
+ enabled: boolean;
805
804
  }
806
805
  export type AddOptionServerRequest = {
807
- /**
808
- * Zone to target. If none is passed will use default zone from the config.
809
- */
810
- zone?: ScwZone;
811
- /**
812
- * ID of the server.
813
- */
814
- serverId: string;
815
- /**
816
- * ID of the option to add.
817
- */
818
- optionId: string;
819
- /**
820
- * Auto expire the option after this date.
821
- */
822
- expiresAt?: Date;
806
+ /**
807
+ * Zone to target. If none is passed will use default zone from the config.
808
+ */
809
+ zone?: Zone;
810
+ /**
811
+ * ID of the server.
812
+ */
813
+ serverId: string;
814
+ /**
815
+ * ID of the option to add.
816
+ */
817
+ optionId: string;
818
+ /**
819
+ * Auto expire the option after this date.
820
+ */
821
+ expiresAt?: Date;
823
822
  };
824
823
  export interface BMCAccess {
825
- /**
826
- * URL to access to the server console.
827
- */
828
- url: string;
829
- /**
830
- * The login to use for the BMC (Baseboard Management Controller) access authentication.
831
- */
832
- login: string;
833
- /**
834
- * The password to use for the BMC (Baseboard Management Controller) access authentication.
835
- */
836
- password: string;
837
- /**
838
- * The date after which the BMC (Baseboard Management Controller) access will be closed.
839
- */
840
- expiresAt?: Date;
824
+ /**
825
+ * URL to access to the server console.
826
+ */
827
+ url: string;
828
+ /**
829
+ * The login to use for the BMC (Baseboard Management Controller) access authentication.
830
+ */
831
+ login: string;
832
+ /**
833
+ * The password to use for the BMC (Baseboard Management Controller) access authentication.
834
+ */
835
+ password: string;
836
+ /**
837
+ * The date after which the BMC (Baseboard Management Controller) access will be closed.
838
+ */
839
+ expiresAt?: Date;
841
840
  }
842
841
  export type BatchCreateServersRequest = {
843
- /**
844
- * Zone to target. If none is passed will use default zone from the config.
845
- */
846
- zone?: ScwZone;
847
- /**
848
- * Configuration wanted for the servers to create.
849
- */
850
- commonConfiguration?: CreateServerRequest;
851
- /**
852
- * List of servers to create.
853
- */
854
- servers?: BatchCreateServersRequestServerConfig[];
842
+ /**
843
+ * Zone to target. If none is passed will use default zone from the config.
844
+ */
845
+ zone?: Zone;
846
+ /**
847
+ * Configuration wanted for the servers to create.
848
+ */
849
+ commonConfiguration?: CreateServerRequest;
850
+ /**
851
+ * List of servers to create.
852
+ */
853
+ servers?: BatchCreateServersRequestServerConfig[];
855
854
  };
856
855
  export interface BatchCreateServersResponse {
857
- servers: Server[];
856
+ servers: Server[];
858
857
  }
859
858
  export type DeleteOptionServerRequest = {
860
- /**
861
- * Zone to target. If none is passed will use default zone from the config.
862
- */
863
- zone?: ScwZone;
864
- /**
865
- * ID of the server.
866
- */
867
- serverId: string;
868
- /**
869
- * ID of the option to delete.
870
- */
871
- optionId: string;
859
+ /**
860
+ * Zone to target. If none is passed will use default zone from the config.
861
+ */
862
+ zone?: Zone;
863
+ /**
864
+ * ID of the server.
865
+ */
866
+ serverId: string;
867
+ /**
868
+ * ID of the option to delete.
869
+ */
870
+ optionId: string;
872
871
  };
873
872
  export type DeleteServerRequest = {
874
- /**
875
- * Zone to target. If none is passed will use default zone from the config.
876
- */
877
- zone?: ScwZone;
878
- /**
879
- * ID of the server to delete.
880
- */
881
- serverId: string;
873
+ /**
874
+ * Zone to target. If none is passed will use default zone from the config.
875
+ */
876
+ zone?: Zone;
877
+ /**
878
+ * ID of the server to delete.
879
+ */
880
+ serverId: string;
882
881
  };
883
882
  export type GetBMCAccessRequest = {
884
- /**
885
- * Zone to target. If none is passed will use default zone from the config.
886
- */
887
- zone?: ScwZone;
888
- /**
889
- * ID of the server.
890
- */
891
- serverId: string;
883
+ /**
884
+ * Zone to target. If none is passed will use default zone from the config.
885
+ */
886
+ zone?: Zone;
887
+ /**
888
+ * ID of the server.
889
+ */
890
+ serverId: string;
892
891
  };
893
892
  export type GetDefaultPartitioningSchemaRequest = {
894
- /**
895
- * Zone to target. If none is passed will use default zone from the config.
896
- */
897
- zone?: ScwZone;
898
- /**
899
- * ID of the offer.
900
- */
901
- offerId: string;
902
- /**
903
- * ID of the OS.
904
- */
905
- osId: string;
893
+ /**
894
+ * Zone to target. If none is passed will use default zone from the config.
895
+ */
896
+ zone?: Zone;
897
+ /**
898
+ * ID of the offer.
899
+ */
900
+ offerId: string;
901
+ /**
902
+ * ID of the OS.
903
+ */
904
+ osId: string;
906
905
  };
907
906
  export type GetOSRequest = {
908
- /**
909
- * Zone to target. If none is passed will use default zone from the config.
910
- */
911
- zone?: ScwZone;
912
- /**
913
- * ID of the OS.
914
- */
915
- osId: string;
907
+ /**
908
+ * Zone to target. If none is passed will use default zone from the config.
909
+ */
910
+ zone?: Zone;
911
+ /**
912
+ * ID of the OS.
913
+ */
914
+ osId: string;
916
915
  };
917
916
  export type GetOfferRequest = {
918
- /**
919
- * Zone to target. If none is passed will use default zone from the config.
920
- */
921
- zone?: ScwZone;
922
- /**
923
- * ID of the researched Offer.
924
- */
925
- offerId: string;
917
+ /**
918
+ * Zone to target. If none is passed will use default zone from the config.
919
+ */
920
+ zone?: Zone;
921
+ /**
922
+ * ID of the researched Offer.
923
+ */
924
+ offerId: string;
926
925
  };
927
926
  export type GetOptionRequest = {
928
- /**
929
- * Zone to target. If none is passed will use default zone from the config.
930
- */
931
- zone?: ScwZone;
932
- /**
933
- * ID of the option.
934
- */
935
- optionId: string;
927
+ /**
928
+ * Zone to target. If none is passed will use default zone from the config.
929
+ */
930
+ zone?: Zone;
931
+ /**
932
+ * ID of the option.
933
+ */
934
+ optionId: string;
936
935
  };
937
936
  export type GetServerMetricsRequest = {
938
- /**
939
- * Zone to target. If none is passed will use default zone from the config.
940
- */
941
- zone?: ScwZone;
942
- /**
943
- * Server ID to get the metrics.
944
- */
945
- serverId: string;
937
+ /**
938
+ * Zone to target. If none is passed will use default zone from the config.
939
+ */
940
+ zone?: Zone;
941
+ /**
942
+ * Server ID to get the metrics.
943
+ */
944
+ serverId: string;
946
945
  };
947
946
  export interface GetServerMetricsResponse {
948
- /**
949
- * Timeseries object representing pings on the server.
950
- */
951
- pings?: TimeSeries;
947
+ /**
948
+ * Timeseries object representing pings on the server.
949
+ */
950
+ pings?: TimeSeries;
952
951
  }
953
952
  export type GetServerRequest = {
954
- /**
955
- * Zone to target. If none is passed will use default zone from the config.
956
- */
957
- zone?: ScwZone;
958
- /**
959
- * ID of the server.
960
- */
961
- serverId: string;
953
+ /**
954
+ * Zone to target. If none is passed will use default zone from the config.
955
+ */
956
+ zone?: Zone;
957
+ /**
958
+ * ID of the server.
959
+ */
960
+ serverId: string;
962
961
  };
963
962
  export type InstallServerRequest = {
964
- /**
965
- * Zone to target. If none is passed will use default zone from the config.
966
- */
967
- zone?: ScwZone;
968
- /**
969
- * Server ID to install.
970
- */
971
- serverId: string;
972
- /**
973
- * ID of the OS to installation on the server.
974
- */
975
- osId: string;
976
- /**
977
- * Hostname of the server.
978
- */
979
- hostname: string;
980
- /**
981
- * SSH key IDs authorized on the server.
982
- */
983
- sshKeyIds: string[];
984
- /**
985
- * User used for the installation.
986
- */
987
- user?: string;
988
- /**
989
- * Password used for the installation.
990
- */
991
- password?: string;
992
- /**
993
- * User used for the service to install.
994
- */
995
- serviceUser?: string;
996
- /**
997
- * Password used for the service to install.
998
- */
999
- servicePassword?: string;
1000
- /**
1001
- * Partitioning schema.
1002
- */
1003
- partitioningSchema?: Schema;
1004
- /**
1005
- * @deprecated Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.
1006
- */
1007
- userData?: Blob;
963
+ /**
964
+ * Zone to target. If none is passed will use default zone from the config.
965
+ */
966
+ zone?: Zone;
967
+ /**
968
+ * Server ID to install.
969
+ */
970
+ serverId: string;
971
+ /**
972
+ * ID of the OS to installation on the server.
973
+ */
974
+ osId: string;
975
+ /**
976
+ * Hostname of the server.
977
+ */
978
+ hostname: string;
979
+ /**
980
+ * SSH key IDs authorized on the server.
981
+ */
982
+ sshKeyIds: string[];
983
+ /**
984
+ * User used for the installation.
985
+ */
986
+ user?: string;
987
+ /**
988
+ * Password used for the installation.
989
+ */
990
+ password?: string;
991
+ /**
992
+ * User used for the service to install.
993
+ */
994
+ serviceUser?: string;
995
+ /**
996
+ * Password used for the service to install.
997
+ */
998
+ servicePassword?: string;
999
+ /**
1000
+ * Partitioning schema.
1001
+ */
1002
+ partitioningSchema?: Schema;
1003
+ /**
1004
+ * @deprecated Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.
1005
+ */
1006
+ userData?: Blob;
1008
1007
  };
1009
1008
  export type ListOSRequest = {
1010
- /**
1011
- * Zone to target. If none is passed will use default zone from the config.
1012
- */
1013
- zone?: ScwZone;
1014
- /**
1015
- * Page number.
1016
- */
1017
- page?: number;
1018
- /**
1019
- * Number of OS per page.
1020
- */
1021
- pageSize?: number;
1022
- /**
1023
- * Offer IDs to filter OSes for.
1024
- */
1025
- offerId?: string;
1009
+ /**
1010
+ * Zone to target. If none is passed will use default zone from the config.
1011
+ */
1012
+ zone?: Zone;
1013
+ /**
1014
+ * Page number.
1015
+ */
1016
+ page?: number;
1017
+ /**
1018
+ * Number of OS per page.
1019
+ */
1020
+ pageSize?: number;
1021
+ /**
1022
+ * Offer IDs to filter OSes for.
1023
+ */
1024
+ offerId?: string;
1026
1025
  };
1027
1026
  export interface ListOSResponse {
1028
- /**
1029
- * Total count of matching OS.
1030
- */
1031
- totalCount: number;
1032
- /**
1033
- * OS that match filters.
1034
- */
1035
- os: OS[];
1027
+ /**
1028
+ * Total count of matching OS.
1029
+ */
1030
+ totalCount: number;
1031
+ /**
1032
+ * OS that match filters.
1033
+ */
1034
+ os: OS[];
1036
1035
  }
1037
1036
  export type ListOffersRequest = {
1038
- /**
1039
- * Zone to target. If none is passed will use default zone from the config.
1040
- */
1041
- zone?: ScwZone;
1042
- /**
1043
- * Page number.
1044
- */
1045
- page?: number;
1046
- /**
1047
- * Number of offers per page.
1048
- */
1049
- pageSize?: number;
1050
- /**
1051
- * Subscription period type to filter offers by.
1052
- */
1053
- subscriptionPeriod?: OfferSubscriptionPeriod;
1054
- /**
1055
- * Offer name to filter offers by.
1056
- */
1057
- name?: string;
1037
+ /**
1038
+ * Zone to target. If none is passed will use default zone from the config.
1039
+ */
1040
+ zone?: Zone;
1041
+ /**
1042
+ * Page number.
1043
+ */
1044
+ page?: number;
1045
+ /**
1046
+ * Number of offers per page.
1047
+ */
1048
+ pageSize?: number;
1049
+ /**
1050
+ * Subscription period type to filter offers by.
1051
+ */
1052
+ subscriptionPeriod?: OfferSubscriptionPeriod;
1053
+ /**
1054
+ * Offer name to filter offers by.
1055
+ */
1056
+ name?: string;
1058
1057
  };
1059
1058
  export interface ListOffersResponse {
1060
- /**
1061
- * Total count of matching offers.
1062
- */
1063
- totalCount: number;
1064
- /**
1065
- * Offers that match filters.
1066
- */
1067
- offers: Offer[];
1059
+ /**
1060
+ * Total count of matching offers.
1061
+ */
1062
+ totalCount: number;
1063
+ /**
1064
+ * Offers that match filters.
1065
+ */
1066
+ offers: Offer[];
1068
1067
  }
1069
1068
  export type ListOptionsRequest = {
1070
- /**
1071
- * Zone to target. If none is passed will use default zone from the config.
1072
- */
1073
- zone?: ScwZone;
1074
- /**
1075
- * Page number.
1076
- */
1077
- page?: number;
1078
- /**
1079
- * Number of options per page.
1080
- */
1081
- pageSize?: number;
1082
- /**
1083
- * Offer ID to filter options for.
1084
- */
1085
- offerId?: string;
1086
- /**
1087
- * Name to filter options for.
1088
- */
1089
- name?: string;
1069
+ /**
1070
+ * Zone to target. If none is passed will use default zone from the config.
1071
+ */
1072
+ zone?: Zone;
1073
+ /**
1074
+ * Page number.
1075
+ */
1076
+ page?: number;
1077
+ /**
1078
+ * Number of options per page.
1079
+ */
1080
+ pageSize?: number;
1081
+ /**
1082
+ * Offer ID to filter options for.
1083
+ */
1084
+ offerId?: string;
1085
+ /**
1086
+ * Name to filter options for.
1087
+ */
1088
+ name?: string;
1090
1089
  };
1091
1090
  export interface ListOptionsResponse {
1092
- /**
1093
- * Total count of matching options.
1094
- */
1095
- totalCount: number;
1096
- /**
1097
- * Options that match filters.
1098
- */
1099
- options: Option[];
1091
+ /**
1092
+ * Total count of matching options.
1093
+ */
1094
+ totalCount: number;
1095
+ /**
1096
+ * Options that match filters.
1097
+ */
1098
+ options: Option[];
1100
1099
  }
1101
1100
  export type ListServerEventsRequest = {
1102
- /**
1103
- * Zone to target. If none is passed will use default zone from the config.
1104
- */
1105
- zone?: ScwZone;
1106
- /**
1107
- * ID of the server events searched.
1108
- */
1109
- serverId: string;
1110
- /**
1111
- * Page number.
1112
- */
1113
- page?: number;
1114
- /**
1115
- * Number of server events per page.
1116
- */
1117
- pageSize?: number;
1118
- /**
1119
- * Order of the server events.
1120
- */
1121
- orderBy?: ListServerEventsRequestOrderBy;
1101
+ /**
1102
+ * Zone to target. If none is passed will use default zone from the config.
1103
+ */
1104
+ zone?: Zone;
1105
+ /**
1106
+ * ID of the server events searched.
1107
+ */
1108
+ serverId: string;
1109
+ /**
1110
+ * Page number.
1111
+ */
1112
+ page?: number;
1113
+ /**
1114
+ * Number of server events per page.
1115
+ */
1116
+ pageSize?: number;
1117
+ /**
1118
+ * Order of the server events.
1119
+ */
1120
+ orderBy?: ListServerEventsRequestOrderBy;
1122
1121
  };
1123
1122
  export interface ListServerEventsResponse {
1124
- /**
1125
- * Total count of matching events.
1126
- */
1127
- totalCount: number;
1128
- /**
1129
- * Server events that match filters.
1130
- */
1131
- events: ServerEvent[];
1123
+ /**
1124
+ * Total count of matching events.
1125
+ */
1126
+ totalCount: number;
1127
+ /**
1128
+ * Server events that match filters.
1129
+ */
1130
+ events: ServerEvent[];
1132
1131
  }
1133
1132
  export interface ListServerPrivateNetworksResponse {
1134
- serverPrivateNetworks: ServerPrivateNetwork[];
1135
- totalCount: number;
1133
+ serverPrivateNetworks: ServerPrivateNetwork[];
1134
+ totalCount: number;
1136
1135
  }
1137
1136
  export type ListServersRequest = {
1138
- /**
1139
- * Zone to target. If none is passed will use default zone from the config.
1140
- */
1141
- zone?: ScwZone;
1142
- /**
1143
- * Page number.
1144
- */
1145
- page?: number;
1146
- /**
1147
- * Number of servers per page.
1148
- */
1149
- pageSize?: number;
1150
- /**
1151
- * Order of the servers.
1152
- */
1153
- orderBy?: ListServersRequestOrderBy;
1154
- /**
1155
- * Tags to filter for.
1156
- */
1157
- tags?: string[];
1158
- /**
1159
- * Status to filter for.
1160
- */
1161
- status?: string[];
1162
- /**
1163
- * Names to filter for.
1164
- */
1165
- name?: string;
1166
- /**
1167
- * Organization ID to filter for.
1168
- */
1169
- organizationId?: string;
1170
- /**
1171
- * Project ID to filter for.
1172
- */
1173
- projectId?: string;
1174
- /**
1175
- * Option ID to filter for.
1176
- */
1177
- optionId?: string;
1137
+ /**
1138
+ * Zone to target. If none is passed will use default zone from the config.
1139
+ */
1140
+ zone?: Zone;
1141
+ /**
1142
+ * Page number.
1143
+ */
1144
+ page?: number;
1145
+ /**
1146
+ * Number of servers per page.
1147
+ */
1148
+ pageSize?: number;
1149
+ /**
1150
+ * Order of the servers.
1151
+ */
1152
+ orderBy?: ListServersRequestOrderBy;
1153
+ /**
1154
+ * Tags to filter for.
1155
+ */
1156
+ tags?: string[];
1157
+ /**
1158
+ * Status to filter for.
1159
+ */
1160
+ status?: string[];
1161
+ /**
1162
+ * Names to filter for.
1163
+ */
1164
+ name?: string;
1165
+ /**
1166
+ * Organization ID to filter for.
1167
+ */
1168
+ organizationId?: string;
1169
+ /**
1170
+ * Project ID to filter for.
1171
+ */
1172
+ projectId?: string;
1173
+ /**
1174
+ * Option ID to filter for.
1175
+ */
1176
+ optionId?: string;
1178
1177
  };
1179
1178
  export interface ListServersResponse {
1180
- /**
1181
- * Total count of matching servers.
1182
- */
1183
- totalCount: number;
1184
- /**
1185
- * Array of Elastic Metal server objects matching the filters in the request.
1186
- */
1187
- servers: Server[];
1179
+ /**
1180
+ * Total count of matching servers.
1181
+ */
1182
+ totalCount: number;
1183
+ /**
1184
+ * Array of Elastic Metal server objects matching the filters in the request.
1185
+ */
1186
+ servers: Server[];
1188
1187
  }
1189
1188
  export type ListSettingsRequest = {
1190
- /**
1191
- * Zone to target. If none is passed will use default zone from the config.
1192
- */
1193
- zone?: ScwZone;
1194
- /**
1195
- * Page number.
1196
- */
1197
- page?: number;
1198
- /**
1199
- * Set the maximum list size.
1200
- */
1201
- pageSize?: number;
1202
- /**
1203
- * Sort order for items in the response.
1204
- */
1205
- orderBy?: ListSettingsRequestOrderBy;
1206
- /**
1207
- * ID of the Project.
1208
- */
1209
- projectId?: string;
1189
+ /**
1190
+ * Zone to target. If none is passed will use default zone from the config.
1191
+ */
1192
+ zone?: Zone;
1193
+ /**
1194
+ * Page number.
1195
+ */
1196
+ page?: number;
1197
+ /**
1198
+ * Set the maximum list size.
1199
+ */
1200
+ pageSize?: number;
1201
+ /**
1202
+ * Sort order for items in the response.
1203
+ */
1204
+ orderBy?: ListSettingsRequestOrderBy;
1205
+ /**
1206
+ * ID of the Project.
1207
+ */
1208
+ projectId?: string;
1210
1209
  };
1211
1210
  export interface ListSettingsResponse {
1212
- /**
1213
- * Total count of matching settings.
1214
- */
1215
- totalCount: number;
1216
- /**
1217
- * Settings that match filters.
1218
- */
1219
- settings: Setting[];
1211
+ /**
1212
+ * Total count of matching settings.
1213
+ */
1214
+ totalCount: number;
1215
+ /**
1216
+ * Settings that match filters.
1217
+ */
1218
+ settings: Setting[];
1220
1219
  }
1221
1220
  export type MigrateServerToMonthlyOfferRequest = {
1222
- /**
1223
- * Zone to target. If none is passed will use default zone from the config.
1224
- */
1225
- zone?: ScwZone;
1226
- /**
1227
- * ID of the server.
1228
- */
1229
- serverId: string;
1221
+ /**
1222
+ * Zone to target. If none is passed will use default zone from the config.
1223
+ */
1224
+ zone?: Zone;
1225
+ /**
1226
+ * ID of the server.
1227
+ */
1228
+ serverId: string;
1230
1229
  };
1231
1230
  export type PrivateNetworkApiAddServerPrivateNetworkRequest = {
1232
- /**
1233
- * Zone to target. If none is passed will use default zone from the config.
1234
- */
1235
- zone?: ScwZone;
1236
- /**
1237
- * The ID of the server.
1238
- */
1239
- serverId: string;
1240
- /**
1241
- * The ID of the Private Network.
1242
- */
1243
- privateNetworkId: string;
1231
+ /**
1232
+ * Zone to target. If none is passed will use default zone from the config.
1233
+ */
1234
+ zone?: Zone;
1235
+ /**
1236
+ * The ID of the server.
1237
+ */
1238
+ serverId: string;
1239
+ /**
1240
+ * The ID of the Private Network.
1241
+ */
1242
+ privateNetworkId: string;
1244
1243
  };
1245
1244
  export type PrivateNetworkApiDeleteServerPrivateNetworkRequest = {
1246
- /**
1247
- * Zone to target. If none is passed will use default zone from the config.
1248
- */
1249
- zone?: ScwZone;
1250
- /**
1251
- * The ID of the server.
1252
- */
1253
- serverId: string;
1254
- /**
1255
- * The ID of the Private Network.
1256
- */
1257
- privateNetworkId: string;
1245
+ /**
1246
+ * Zone to target. If none is passed will use default zone from the config.
1247
+ */
1248
+ zone?: Zone;
1249
+ /**
1250
+ * The ID of the server.
1251
+ */
1252
+ serverId: string;
1253
+ /**
1254
+ * The ID of the Private Network.
1255
+ */
1256
+ privateNetworkId: string;
1258
1257
  };
1259
1258
  export type PrivateNetworkApiListServerPrivateNetworksRequest = {
1260
- /**
1261
- * Zone to target. If none is passed will use default zone from the config.
1262
- */
1263
- zone?: ScwZone;
1264
- /**
1265
- * The sort order for the returned Private Networks.
1266
- */
1267
- orderBy?: ListServerPrivateNetworksRequestOrderBy;
1268
- /**
1269
- * The page number for the returned Private Networks.
1270
- */
1271
- page?: number;
1272
- /**
1273
- * The maximum number of Private Networks per page.
1274
- */
1275
- pageSize?: number;
1276
- /**
1277
- * Filter Private Networks by server ID.
1278
- */
1279
- serverId?: string;
1280
- /**
1281
- * Filter Private Networks by Private Network ID.
1282
- */
1283
- privateNetworkId?: string;
1284
- /**
1285
- * Filter Private Networks by Organization ID.
1286
- */
1287
- organizationId?: string;
1288
- /**
1289
- * Filter Private Networks by Project ID.
1290
- */
1291
- projectId?: string;
1259
+ /**
1260
+ * Zone to target. If none is passed will use default zone from the config.
1261
+ */
1262
+ zone?: Zone;
1263
+ /**
1264
+ * The sort order for the returned Private Networks.
1265
+ */
1266
+ orderBy?: ListServerPrivateNetworksRequestOrderBy;
1267
+ /**
1268
+ * The page number for the returned Private Networks.
1269
+ */
1270
+ page?: number;
1271
+ /**
1272
+ * The maximum number of Private Networks per page.
1273
+ */
1274
+ pageSize?: number;
1275
+ /**
1276
+ * Filter Private Networks by server ID.
1277
+ */
1278
+ serverId?: string;
1279
+ /**
1280
+ * Filter Private Networks by Private Network ID.
1281
+ */
1282
+ privateNetworkId?: string;
1283
+ /**
1284
+ * Filter Private Networks by Organization ID.
1285
+ */
1286
+ organizationId?: string;
1287
+ /**
1288
+ * Filter Private Networks by Project ID.
1289
+ */
1290
+ projectId?: string;
1292
1291
  };
1293
1292
  export type PrivateNetworkApiSetServerPrivateNetworksRequest = {
1294
- /**
1295
- * Zone to target. If none is passed will use default zone from the config.
1296
- */
1297
- zone?: ScwZone;
1298
- /**
1299
- * The ID of the server.
1300
- */
1301
- serverId: string;
1302
- /**
1303
- * The IDs of the Private Networks.
1304
- */
1305
- privateNetworkIds: string[];
1293
+ /**
1294
+ * Zone to target. If none is passed will use default zone from the config.
1295
+ */
1296
+ zone?: Zone;
1297
+ /**
1298
+ * The ID of the server.
1299
+ */
1300
+ serverId: string;
1301
+ /**
1302
+ * The IDs of the Private Networks.
1303
+ */
1304
+ privateNetworkIds: string[];
1306
1305
  };
1307
1306
  export type RebootServerRequest = {
1308
- /**
1309
- * Zone to target. If none is passed will use default zone from the config.
1310
- */
1311
- zone?: ScwZone;
1312
- /**
1313
- * ID of the server to reboot.
1314
- */
1315
- serverId: string;
1316
- /**
1317
- * The type of boot.
1318
- */
1319
- bootType?: ServerBootType;
1320
- /**
1321
- * Additional SSH public key IDs to configure on rescue image.
1322
- */
1323
- sshKeyIds?: string[];
1307
+ /**
1308
+ * Zone to target. If none is passed will use default zone from the config.
1309
+ */
1310
+ zone?: Zone;
1311
+ /**
1312
+ * ID of the server to reboot.
1313
+ */
1314
+ serverId: string;
1315
+ /**
1316
+ * The type of boot.
1317
+ */
1318
+ bootType?: ServerBootType;
1319
+ /**
1320
+ * Additional SSH public key IDs to configure on rescue image.
1321
+ */
1322
+ sshKeyIds?: string[];
1324
1323
  };
1325
1324
  export interface SetServerPrivateNetworksResponse {
1326
- serverPrivateNetworks: ServerPrivateNetwork[];
1325
+ serverPrivateNetworks: ServerPrivateNetwork[];
1327
1326
  }
1328
1327
  export type StartBMCAccessRequest = {
1329
- /**
1330
- * Zone to target. If none is passed will use default zone from the config.
1331
- */
1332
- zone?: ScwZone;
1333
- /**
1334
- * ID of the server.
1335
- */
1336
- serverId: string;
1337
- /**
1338
- * The IP authorized to connect to the server.
1339
- */
1340
- ip: string;
1328
+ /**
1329
+ * Zone to target. If none is passed will use default zone from the config.
1330
+ */
1331
+ zone?: Zone;
1332
+ /**
1333
+ * ID of the server.
1334
+ */
1335
+ serverId: string;
1336
+ /**
1337
+ * The IP authorized to connect to the server.
1338
+ */
1339
+ ip: string;
1341
1340
  };
1342
1341
  export type StartServerRequest = {
1343
- /**
1344
- * Zone to target. If none is passed will use default zone from the config.
1345
- */
1346
- zone?: ScwZone;
1347
- /**
1348
- * ID of the server to start.
1349
- */
1350
- serverId: string;
1351
- /**
1352
- * The type of boot.
1353
- */
1354
- bootType?: ServerBootType;
1355
- /**
1356
- * Additional SSH public key IDs to configure on rescue image.
1357
- */
1358
- sshKeyIds?: string[];
1342
+ /**
1343
+ * Zone to target. If none is passed will use default zone from the config.
1344
+ */
1345
+ zone?: Zone;
1346
+ /**
1347
+ * ID of the server to start.
1348
+ */
1349
+ serverId: string;
1350
+ /**
1351
+ * The type of boot.
1352
+ */
1353
+ bootType?: ServerBootType;
1354
+ /**
1355
+ * Additional SSH public key IDs to configure on rescue image.
1356
+ */
1357
+ sshKeyIds?: string[];
1359
1358
  };
1360
1359
  export type StopBMCAccessRequest = {
1361
- /**
1362
- * Zone to target. If none is passed will use default zone from the config.
1363
- */
1364
- zone?: ScwZone;
1365
- /**
1366
- * ID of the server.
1367
- */
1368
- serverId: string;
1360
+ /**
1361
+ * Zone to target. If none is passed will use default zone from the config.
1362
+ */
1363
+ zone?: Zone;
1364
+ /**
1365
+ * ID of the server.
1366
+ */
1367
+ serverId: string;
1369
1368
  };
1370
1369
  export type StopServerRequest = {
1371
- /**
1372
- * Zone to target. If none is passed will use default zone from the config.
1373
- */
1374
- zone?: ScwZone;
1375
- /**
1376
- * ID of the server to stop.
1377
- */
1378
- serverId: string;
1370
+ /**
1371
+ * Zone to target. If none is passed will use default zone from the config.
1372
+ */
1373
+ zone?: Zone;
1374
+ /**
1375
+ * ID of the server to stop.
1376
+ */
1377
+ serverId: string;
1379
1378
  };
1380
1379
  export type UpdateIPRequest = {
1381
- /**
1382
- * Zone to target. If none is passed will use default zone from the config.
1383
- */
1384
- zone?: ScwZone;
1385
- /**
1386
- * ID of the server.
1387
- */
1388
- serverId: string;
1389
- /**
1390
- * ID of the IP to update.
1391
- */
1392
- ipId: string;
1393
- /**
1394
- * New reverse IP to update, not updated if null.
1395
- */
1396
- reverse?: string;
1380
+ /**
1381
+ * Zone to target. If none is passed will use default zone from the config.
1382
+ */
1383
+ zone?: Zone;
1384
+ /**
1385
+ * ID of the server.
1386
+ */
1387
+ serverId: string;
1388
+ /**
1389
+ * ID of the IP to update.
1390
+ */
1391
+ ipId: string;
1392
+ /**
1393
+ * New reverse IP to update, not updated if null.
1394
+ */
1395
+ reverse?: string;
1397
1396
  };
1398
1397
  export type UpdateServerRequest = {
1399
- /**
1400
- * Zone to target. If none is passed will use default zone from the config.
1401
- */
1402
- zone?: ScwZone;
1403
- /**
1404
- * ID of the server to update.
1405
- */
1406
- serverId: string;
1407
- /**
1408
- * Name of the server (≠hostname), not updated if null.
1409
- */
1410
- name?: string;
1411
- /**
1412
- * Description associated with the server, max 255 characters, not updated if null.
1413
- */
1414
- description?: string;
1415
- /**
1416
- * Tags associated with the server, not updated if null.
1417
- */
1418
- tags?: string[];
1419
- /**
1420
- * If enabled, the server can not be deleted.
1421
- */
1422
- protected?: boolean;
1423
- /**
1424
- * Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.
1425
- */
1426
- userData?: string;
1398
+ /**
1399
+ * Zone to target. If none is passed will use default zone from the config.
1400
+ */
1401
+ zone?: Zone;
1402
+ /**
1403
+ * ID of the server to update.
1404
+ */
1405
+ serverId: string;
1406
+ /**
1407
+ * Name of the server (≠hostname), not updated if null.
1408
+ */
1409
+ name?: string;
1410
+ /**
1411
+ * Description associated with the server, max 255 characters, not updated if null.
1412
+ */
1413
+ description?: string;
1414
+ /**
1415
+ * Tags associated with the server, not updated if null.
1416
+ */
1417
+ tags?: string[];
1418
+ /**
1419
+ * If enabled, the server can not be deleted.
1420
+ */
1421
+ protected?: boolean;
1422
+ /**
1423
+ * Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script.
1424
+ */
1425
+ userData?: string;
1427
1426
  };
1428
1427
  export type UpdateSettingRequest = {
1429
- /**
1430
- * Zone to target. If none is passed will use default zone from the config.
1431
- */
1432
- zone?: ScwZone;
1433
- /**
1434
- * ID of the setting.
1435
- */
1436
- settingId: string;
1437
- /**
1438
- * Defines whether the setting is enabled.
1439
- */
1440
- enabled?: boolean;
1428
+ /**
1429
+ * Zone to target. If none is passed will use default zone from the config.
1430
+ */
1431
+ zone?: Zone;
1432
+ /**
1433
+ * ID of the setting.
1434
+ */
1435
+ settingId: string;
1436
+ /**
1437
+ * Defines whether the setting is enabled.
1438
+ */
1439
+ enabled?: boolean;
1441
1440
  };
1442
1441
  export type ValidatePartitioningSchemaRequest = {
1443
- /**
1444
- * Zone to target. If none is passed will use default zone from the config.
1445
- */
1446
- zone?: ScwZone;
1447
- /**
1448
- * Partitioning schema.
1449
- */
1450
- partitioningSchema?: Schema;
1451
- /**
1452
- * Offer ID of the server.
1453
- */
1454
- offerId: string;
1455
- /**
1456
- * OS ID.
1457
- */
1458
- osId: string;
1442
+ /**
1443
+ * Zone to target. If none is passed will use default zone from the config.
1444
+ */
1445
+ zone?: Zone;
1446
+ /**
1447
+ * Partitioning schema.
1448
+ */
1449
+ partitioningSchema?: Schema;
1450
+ /**
1451
+ * Offer ID of the server.
1452
+ */
1453
+ offerId: string;
1454
+ /**
1455
+ * OS ID.
1456
+ */
1457
+ osId: string;
1459
1458
  };
1459
+ //#endregion