@scaleway/sdk 2.72.0 → 2.73.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/dist/api/account/v3/api.gen.cjs +13 -32
  2. package/dist/api/account/v3/api.gen.d.ts +17 -36
  3. package/dist/api/account/v3/api.gen.js +13 -32
  4. package/dist/api/account/v3/types.gen.d.ts +187 -85
  5. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  6. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  7. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  8. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  9. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  10. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  11. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  12. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  13. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  14. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  15. package/dist/api/baremetal/v1/api.gen.js +28 -61
  16. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  17. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  18. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  19. package/dist/api/baremetal/v3/api.gen.js +7 -14
  20. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  21. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  22. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  23. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  24. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  25. package/dist/api/block/v1/api.gen.cjs +37 -55
  26. package/dist/api/block/v1/api.gen.d.ts +19 -37
  27. package/dist/api/block/v1/api.gen.js +37 -55
  28. package/dist/api/block/v1/types.gen.d.ts +306 -125
  29. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  30. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  31. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  32. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  33. package/dist/api/cockpit/v1/api.gen.cjs +100 -156
  34. package/dist/api/cockpit/v1/api.gen.d.ts +53 -112
  35. package/dist/api/cockpit/v1/api.gen.js +100 -156
  36. package/dist/api/cockpit/v1/types.gen.d.ts +567 -246
  37. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  38. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  39. package/dist/api/container/v1beta1/api.gen.js +7 -14
  40. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  41. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  42. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  43. package/dist/api/dedibox/v1/api.gen.js +45 -69
  44. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  45. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  46. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  47. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  48. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  49. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  50. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  51. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  52. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  53. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  54. package/dist/api/inference/v1/api.gen.cjs +8 -11
  55. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  56. package/dist/api/inference/v1/api.gen.js +8 -11
  57. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  58. package/dist/api/inference/v1beta1/api.gen.cjs +8 -11
  59. package/dist/api/inference/v1beta1/api.gen.d.ts +6 -9
  60. package/dist/api/inference/v1beta1/api.gen.js +8 -11
  61. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  62. package/dist/api/instance/v1/api.gen.cjs +64 -113
  63. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  64. package/dist/api/instance/v1/api.gen.js +64 -113
  65. package/dist/api/instance/v1/types.gen.d.ts +1351 -598
  66. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  67. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  68. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  69. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  70. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  71. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  72. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  73. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  74. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  75. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  76. package/dist/api/iot/v1/api.gen.cjs +37 -70
  77. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  78. package/dist/api/iot/v1/api.gen.js +37 -70
  79. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  80. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  81. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  82. package/dist/api/ipam/v1/api.gen.js +6 -26
  83. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  84. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  85. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  86. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  87. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  88. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  89. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  90. package/dist/api/k8s/v1/api.gen.js +33 -78
  91. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  92. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  93. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  94. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  95. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  96. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  97. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  98. package/dist/api/marketplace/v2/api.gen.js +8 -21
  99. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  100. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  101. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  102. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  103. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  104. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  105. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  106. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  107. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  108. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  109. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  110. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  111. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  112. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  113. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  114. package/dist/api/rdb/v1/api.gen.js +62 -202
  115. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  116. package/dist/api/redis/v1/api.gen.cjs +23 -83
  117. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  118. package/dist/api/redis/v1/api.gen.js +23 -83
  119. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  120. package/dist/api/registry/v1/api.gen.cjs +12 -40
  121. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  122. package/dist/api/registry/v1/api.gen.js +12 -40
  123. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  124. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  125. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  126. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  127. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  128. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  129. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  130. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  131. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  132. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  133. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  134. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  135. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  136. package/dist/api/test/v1/api.gen.cjs +8 -11
  137. package/dist/api/test/v1/api.gen.d.ts +6 -9
  138. package/dist/api/test/v1/api.gen.js +8 -11
  139. package/dist/api/test/v1/types.gen.d.ts +21 -10
  140. package/dist/client/dist/package.json.cjs +1 -1
  141. package/dist/client/dist/package.json.js +1 -1
  142. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  143. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  144. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  145. package/package.json +2 -2
  146. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -43,35 +43,63 @@ export interface Bootscript {
43
43
  public: boolean;
44
44
  title: string;
45
45
  project: string;
46
- /** Zone to target. If none is passed will use default zone from the config. */
46
+ /**
47
+ * Zone to target. If none is passed will use default zone from the config.
48
+ */
47
49
  zone: ScwZone;
48
50
  }
49
51
  export interface Volume {
50
- /** Volume unique ID. */
52
+ /**
53
+ * Volume unique ID.
54
+ */
51
55
  id: string;
52
- /** Volume name. */
56
+ /**
57
+ * Volume name.
58
+ */
53
59
  name: string;
54
- /** @deprecated Show the volume NBD export URI. */
60
+ /**
61
+ * @deprecated Show the volume NBD export URI.
62
+ */
55
63
  exportUri?: string;
56
- /** Volume disk size. */
64
+ /**
65
+ * Volume disk size.
66
+ */
57
67
  size: number;
58
- /** Volume type. */
68
+ /**
69
+ * Volume type.
70
+ */
59
71
  volumeType: VolumeVolumeType;
60
- /** Volume creation date. */
72
+ /**
73
+ * Volume creation date.
74
+ */
61
75
  creationDate?: Date;
62
- /** Volume modification date. */
76
+ /**
77
+ * Volume modification date.
78
+ */
63
79
  modificationDate?: Date;
64
- /** Volume Organization ID. */
80
+ /**
81
+ * Volume Organization ID.
82
+ */
65
83
  organization: string;
66
- /** Volume Project ID. */
84
+ /**
85
+ * Volume Project ID.
86
+ */
67
87
  project: string;
68
- /** Volume tags. */
88
+ /**
89
+ * Volume tags.
90
+ */
69
91
  tags: string[];
70
- /** Instance attached to the volume. */
92
+ /**
93
+ * Instance attached to the volume.
94
+ */
71
95
  server?: ServerSummary;
72
- /** Volume state. */
96
+ /**
97
+ * Volume state.
98
+ */
73
99
  state: VolumeState;
74
- /** Zone in which the volume is located. */
100
+ /**
101
+ * Zone in which the volume is located.
102
+ */
75
103
  zone: ScwZone;
76
104
  }
77
105
  export interface VolumeSummary {
@@ -81,15 +109,23 @@ export interface VolumeSummary {
81
109
  volumeType: VolumeVolumeType;
82
110
  }
83
111
  export interface ServerTypeNetworkInterface {
84
- /** Maximum internal bandwidth in bits per seconds. */
112
+ /**
113
+ * Maximum internal bandwidth in bits per seconds.
114
+ */
85
115
  internalBandwidth?: number;
86
- /** Maximum internet bandwidth in bits per seconds. */
116
+ /**
117
+ * Maximum internet bandwidth in bits per seconds.
118
+ */
87
119
  internetBandwidth?: number;
88
120
  }
89
121
  export interface ServerTypeVolumeConstraintSizes {
90
- /** Minimum volume size in bytes. */
122
+ /**
123
+ * Minimum volume size in bytes.
124
+ */
91
125
  minSize: number;
92
- /** Maximum volume size in bytes. */
126
+ /**
127
+ * Maximum volume size in bytes.
128
+ */
93
129
  maxSize: number;
94
130
  }
95
131
  export interface Image {
@@ -98,7 +134,9 @@ export interface Image {
98
134
  arch: Arch;
99
135
  creationDate?: Date;
100
136
  modificationDate?: Date;
101
- /** @deprecated */
137
+ /**
138
+ * @deprecated
139
+ */
102
140
  defaultBootscript?: Bootscript;
103
141
  extraVolumes: Record<string, Volume>;
104
142
  fromServer: string;
@@ -108,50 +146,74 @@ export interface Image {
108
146
  state: ImageState;
109
147
  project: string;
110
148
  tags: string[];
111
- /** Zone to target. If none is passed will use default zone from the config. */
149
+ /**
150
+ * Zone to target. If none is passed will use default zone from the config.
151
+ */
112
152
  zone: ScwZone;
113
153
  }
114
154
  export interface PlacementGroup {
115
- /** Placement group unique ID. */
155
+ /**
156
+ * Placement group unique ID.
157
+ */
116
158
  id: string;
117
- /** Placement group name. */
159
+ /**
160
+ * Placement group name.
161
+ */
118
162
  name: string;
119
- /** Placement group Organization ID. */
163
+ /**
164
+ * Placement group Organization ID.
165
+ */
120
166
  organization: string;
121
- /** Placement group Project ID. */
167
+ /**
168
+ * Placement group Project ID.
169
+ */
122
170
  project: string;
123
- /** Placement group tags. */
171
+ /**
172
+ * Placement group tags.
173
+ */
124
174
  tags: string[];
125
175
  /**
126
- * Select the failure mode when the placement cannot be respected, either
127
- * optional or enforced.
176
+ * Select the failure mode when the placement cannot be respected, either optional or enforced.
128
177
  */
129
178
  policyMode: PlacementGroupPolicyMode;
130
179
  /**
131
- * Select the behavior of the placement group, either low_latency (group) or
132
- * max_availability (spread).
180
+ * Select the behavior of the placement group, either low_latency (group) or max_availability (spread).
133
181
  */
134
182
  policyType: PlacementGroupPolicyType;
135
183
  /**
136
- * In the server endpoints the value is always false as it is deprecated. In
137
- * the placement group endpoints the value is correct.
184
+ * In the server endpoints the value is always false as it is deprecated.
185
+ In the placement group endpoints the value is correct.
138
186
  */
139
187
  policyRespected: boolean;
140
- /** Zone in which the placement group is located. */
188
+ /**
189
+ * Zone in which the placement group is located.
190
+ */
141
191
  zone: ScwZone;
142
192
  }
143
193
  export interface PrivateNIC {
144
- /** Private NIC unique ID. */
194
+ /**
195
+ * Private NIC unique ID.
196
+ */
145
197
  id: string;
146
- /** Instance to which the private NIC is attached. */
198
+ /**
199
+ * Instance to which the private NIC is attached.
200
+ */
147
201
  serverId: string;
148
- /** Private Network the private NIC is attached to. */
202
+ /**
203
+ * Private Network the private NIC is attached to.
204
+ */
149
205
  privateNetworkId: string;
150
- /** Private NIC MAC address. */
206
+ /**
207
+ * Private NIC MAC address.
208
+ */
151
209
  macAddress: string;
152
- /** Private NIC state. */
210
+ /**
211
+ * Private NIC state.
212
+ */
153
213
  state: PrivateNICState;
154
- /** Private NIC tags. */
214
+ /**
215
+ * Private NIC tags.
216
+ */
155
217
  tags: string[];
156
218
  }
157
219
  export interface SecurityGroupSummary {
@@ -159,33 +221,59 @@ export interface SecurityGroupSummary {
159
221
  name: string;
160
222
  }
161
223
  export interface ServerIp {
162
- /** Unique ID of the IP address. */
224
+ /**
225
+ * Unique ID of the IP address.
226
+ */
163
227
  id: string;
164
- /** Instance's public IP-Address. */
228
+ /**
229
+ * Instance's public IP-Address.
230
+ */
165
231
  address: string;
166
- /** Gateway's IP address. */
232
+ /**
233
+ * Gateway's IP address.
234
+ */
167
235
  gateway: string;
168
- /** CIDR netmask. */
236
+ /**
237
+ * CIDR netmask.
238
+ */
169
239
  netmask: string;
170
- /** IP address family (inet or inet6). */
240
+ /**
241
+ * IP address family (inet or inet6).
242
+ */
171
243
  family: ServerIpIpFamily;
172
- /** True if the IP address is dynamic. */
244
+ /**
245
+ * True if the IP address is dynamic.
246
+ */
173
247
  dynamic: boolean;
174
- /** Information about this address provisioning mode. */
248
+ /**
249
+ * Information about this address provisioning mode.
250
+ */
175
251
  provisioningMode: ServerIpProvisioningMode;
176
- /** Tags associated with the IP. */
252
+ /**
253
+ * Tags associated with the IP.
254
+ */
177
255
  tags: string[];
178
- /** The ip_id of an IPAM ip if the ip is created from IPAM, null if not. */
256
+ /**
257
+ * The ip_id of an IPAM ip if the ip is created from IPAM, null if not.
258
+ */
179
259
  ipamId: string;
180
- /** IP address state. */
260
+ /**
261
+ * IP address state.
262
+ */
181
263
  state: ServerIpState;
182
264
  }
183
265
  export interface ServerIpv6 {
184
- /** Instance IPv6 IP-Address. */
266
+ /**
267
+ * Instance IPv6 IP-Address.
268
+ */
185
269
  address: string;
186
- /** IPv6 IP-addresses gateway. */
270
+ /**
271
+ * IPv6 IP-addresses gateway.
272
+ */
187
273
  gateway: string;
188
- /** IPv6 IP-addresses CIDR netmask. */
274
+ /**
275
+ * IPv6 IP-addresses CIDR netmask.
276
+ */
189
277
  netmask: string;
190
278
  }
191
279
  export interface ServerLocation {
@@ -202,7 +290,9 @@ export interface ServerMaintenance {
202
290
  export interface VolumeServer {
203
291
  id: string;
204
292
  name?: string;
205
- /** @deprecated */
293
+ /**
294
+ * @deprecated
295
+ */
206
296
  exportUri?: string;
207
297
  organization?: string;
208
298
  server?: ServerSummary;
@@ -213,41 +303,67 @@ export interface VolumeServer {
213
303
  state?: VolumeServerState;
214
304
  project?: string;
215
305
  boot: boolean;
216
- /** Zone to target. If none is passed will use default zone from the config. */
306
+ /**
307
+ * Zone to target. If none is passed will use default zone from the config.
308
+ */
217
309
  zone: ScwZone;
218
310
  }
219
311
  export interface SnapshotBaseVolume {
220
- /** Volume ID on which the snapshot is based. */
312
+ /**
313
+ * Volume ID on which the snapshot is based.
314
+ */
221
315
  id: string;
222
- /** Volume name on which the snapshot is based on. */
316
+ /**
317
+ * Volume name on which the snapshot is based on.
318
+ */
223
319
  name: string;
224
320
  }
225
321
  export interface ServerTypeCapabilities {
226
- /** Defines whether the Instance supports block storage. */
322
+ /**
323
+ * Defines whether the Instance supports block storage.
324
+ */
227
325
  blockStorage?: boolean;
228
- /** List of supported boot types. */
326
+ /**
327
+ * List of supported boot types.
328
+ */
229
329
  bootTypes: BootType[];
230
330
  }
231
331
  export interface ServerTypeGPUInfo {
232
- /** GPU manufacturer. */
332
+ /**
333
+ * GPU manufacturer.
334
+ */
233
335
  gpuManufacturer: string;
234
- /** GPU model name. */
336
+ /**
337
+ * GPU model name.
338
+ */
235
339
  gpuName: string;
236
- /** RAM of a single GPU, in bytes. */
340
+ /**
341
+ * RAM of a single GPU, in bytes.
342
+ */
237
343
  gpuMemory: number;
238
344
  }
239
345
  export interface ServerTypeNetwork {
240
- /** List of available network interfaces. */
346
+ /**
347
+ * List of available network interfaces.
348
+ */
241
349
  interfaces: ServerTypeNetworkInterface[];
242
- /** Total maximum internal bandwidth in bits per seconds. */
350
+ /**
351
+ * Total maximum internal bandwidth in bits per seconds.
352
+ */
243
353
  sumInternalBandwidth?: number;
244
- /** Total maximum internet bandwidth in bits per seconds. */
354
+ /**
355
+ * Total maximum internet bandwidth in bits per seconds.
356
+ */
245
357
  sumInternetBandwidth?: number;
246
- /** True if IPv6 is enabled. */
358
+ /**
359
+ * True if IPv6 is enabled.
360
+ */
247
361
  ipv6Support: boolean;
248
362
  }
249
363
  export interface ServerTypeVolumeConstraintsByType {
250
- /** Local SSD volumes. */
364
+ /**
365
+ * Local SSD volumes.
366
+ */
251
367
  lSsd?: ServerTypeVolumeConstraintSizes;
252
368
  }
253
369
  export interface VolumeTypeCapabilities {
@@ -258,117 +374,166 @@ export interface VolumeTypeConstraints {
258
374
  max: number;
259
375
  }
260
376
  export interface Server {
261
- /** Instance unique ID. */
377
+ /**
378
+ * Instance unique ID.
379
+ */
262
380
  id: string;
263
- /** Instance name. */
381
+ /**
382
+ * Instance name.
383
+ */
264
384
  name: string;
265
- /** Instance Organization ID. */
385
+ /**
386
+ * Instance Organization ID.
387
+ */
266
388
  organization: string;
267
- /** Instance Project ID. */
389
+ /**
390
+ * Instance Project ID.
391
+ */
268
392
  project: string;
269
- /** List of allowed actions on the Instance. */
393
+ /**
394
+ * List of allowed actions on the Instance.
395
+ */
270
396
  allowedActions: ServerAction[];
271
- /** Tags associated with the Instance. */
397
+ /**
398
+ * Tags associated with the Instance.
399
+ */
272
400
  tags: string[];
273
- /** Instance commercial type (eg. GP1-M). */
401
+ /**
402
+ * Instance commercial type (eg. GP1-M).
403
+ */
274
404
  commercialType: string;
275
- /** Instance creation date. */
405
+ /**
406
+ * Instance creation date.
407
+ */
276
408
  creationDate?: Date;
277
- /** True if a dynamic IPv4 is required. */
409
+ /**
410
+ * True if a dynamic IPv4 is required.
411
+ */
278
412
  dynamicIpRequired: boolean;
279
413
  /**
280
- * @deprecated True to configure the instance so it uses the routed IP mode.
281
- * Use of `routed_ip_enabled` as `False` is deprecated.
414
+ * @deprecated True to configure the instance so it uses the routed IP mode. Use of `routed_ip_enabled` as `False` is deprecated.
282
415
  */
283
416
  routedIpEnabled?: boolean;
284
417
  /**
285
- * @deprecated True if IPv6 is enabled (deprecated and always `False` when
286
- * `routed_ip_enabled` is `True`).
418
+ * @deprecated True if IPv6 is enabled (deprecated and always `False` when `routed_ip_enabled` is `True`).
287
419
  */
288
420
  enableIpv6?: boolean;
289
- /** Instance host name. */
421
+ /**
422
+ * Instance host name.
423
+ */
290
424
  hostname: string;
291
- /** Information about the Instance image. */
425
+ /**
426
+ * Information about the Instance image.
427
+ */
292
428
  image?: Image;
293
- /** Defines whether the Instance protection option is activated. */
429
+ /**
430
+ * Defines whether the Instance protection option is activated.
431
+ */
294
432
  protected: boolean;
295
433
  /**
296
- * Private IP address of the Instance (deprecated and always `null` when
297
- * `routed_ip_enabled` is `True`).
434
+ * Private IP address of the Instance (deprecated and always `null` when `routed_ip_enabled` is `True`).
298
435
  */
299
436
  privateIp?: string;
300
437
  /**
301
- * @deprecated Information about the public IP (deprecated in favor of
302
- * `public_ips`).
438
+ * @deprecated Information about the public IP (deprecated in favor of `public_ips`).
303
439
  */
304
440
  publicIp?: ServerIp;
305
- /** Information about all the public IPs attached to the server. */
441
+ /**
442
+ * Information about all the public IPs attached to the server.
443
+ */
306
444
  publicIps: ServerIp[];
307
- /** The server's MAC address. */
445
+ /**
446
+ * The server's MAC address.
447
+ */
308
448
  macAddress: string;
309
- /** Instance modification date. */
449
+ /**
450
+ * Instance modification date.
451
+ */
310
452
  modificationDate?: Date;
311
- /** Instance state. */
453
+ /**
454
+ * Instance state.
455
+ */
312
456
  state: ServerState;
313
- /** Instance location. */
457
+ /**
458
+ * Instance location.
459
+ */
314
460
  location?: ServerLocation;
315
461
  /**
316
- * @deprecated Instance IPv6 address (deprecated when `routed_ip_enabled` is
317
- * `True`).
462
+ * @deprecated Instance IPv6 address (deprecated when `routed_ip_enabled` is `True`).
318
463
  */
319
464
  ipv6?: ServerIpv6;
320
- /** Instance boot type. */
465
+ /**
466
+ * Instance boot type.
467
+ */
321
468
  bootType: BootType;
322
- /** Instance volumes. */
469
+ /**
470
+ * Instance volumes.
471
+ */
323
472
  volumes: Record<string, VolumeServer>;
324
- /** Instance security group. */
473
+ /**
474
+ * Instance security group.
475
+ */
325
476
  securityGroup?: SecurityGroupSummary;
326
- /** Instance planned maintenance. */
477
+ /**
478
+ * Instance planned maintenance.
479
+ */
327
480
  maintenances: ServerMaintenance[];
328
- /** Detailed information about the Instance state. */
481
+ /**
482
+ * Detailed information about the Instance state.
483
+ */
329
484
  stateDetail: string;
330
- /** Instance architecture. */
485
+ /**
486
+ * Instance architecture.
487
+ */
331
488
  arch: Arch;
332
- /** Instance placement group. */
489
+ /**
490
+ * Instance placement group.
491
+ */
333
492
  placementGroup?: PlacementGroup;
334
- /** Instance private NICs. */
493
+ /**
494
+ * Instance private NICs.
495
+ */
335
496
  privateNics: PrivateNIC[];
336
- /** Zone in which the Instance is located. */
497
+ /**
498
+ * Zone in which the Instance is located.
499
+ */
337
500
  zone: ScwZone;
338
501
  /**
339
- * The public_key value of this key is used to encrypt the admin password.
340
- * When set to an empty string, reset this value and
341
- * admin_password_encrypted_value to an empty string so a new password may be
342
- * generated.
502
+ * The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated.
343
503
  */
344
504
  adminPasswordEncryptionSshKeyId?: string;
345
505
  /**
346
- * This value is reset when admin_password_encryption_ssh_key_id is set to an
347
- * empty string.
506
+ * This value is reset when admin_password_encryption_ssh_key_id is set to an empty string.
348
507
  */
349
508
  adminPasswordEncryptedValue?: string;
350
509
  }
351
510
  export interface VolumeTemplate {
352
- /** UUID of the volume. */
511
+ /**
512
+ * UUID of the volume.
513
+ */
353
514
  id: string;
354
- /** Name of the volume. */
515
+ /**
516
+ * Name of the volume.
517
+ */
355
518
  name: string;
356
- /** Disk size of the volume, must be a multiple of 512. */
519
+ /**
520
+ * Disk size of the volume, must be a multiple of 512.
521
+ */
357
522
  size: number;
358
- /** Type of the volume. */
523
+ /**
524
+ * Type of the volume.
525
+ */
359
526
  volumeType: VolumeVolumeType;
360
527
  /**
361
528
  * @deprecated Organization ID of the volume.
362
529
  *
363
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
364
- * could be set.
530
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
365
531
  */
366
532
  organization?: string;
367
533
  /**
368
534
  * Project ID of the volume.
369
535
  *
370
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
371
- * could be set.
536
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
372
537
  */
373
538
  project?: string;
374
539
  }
@@ -384,49 +549,79 @@ export interface Ip {
384
549
  state: IpState;
385
550
  prefix: string;
386
551
  ipamId: string;
387
- /** Zone to target. If none is passed will use default zone from the config. */
552
+ /**
553
+ * Zone to target. If none is passed will use default zone from the config.
554
+ */
388
555
  zone: ScwZone;
389
556
  }
390
557
  export interface SecurityGroup {
391
- /** Security group unique ID. */
558
+ /**
559
+ * Security group unique ID.
560
+ */
392
561
  id: string;
393
- /** Security group name. */
562
+ /**
563
+ * Security group name.
564
+ */
394
565
  name: string;
395
- /** Security group description. */
566
+ /**
567
+ * Security group description.
568
+ */
396
569
  description: string;
397
570
  /**
398
- * True if SMTP is blocked on IPv4 and IPv6. This feature is read only, please
399
- * open a support ticket if you need to make it configurable.
571
+ * True if SMTP is blocked on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
400
572
  */
401
573
  enableDefaultSecurity: boolean;
402
- /** Default inbound policy. */
574
+ /**
575
+ * Default inbound policy.
576
+ */
403
577
  inboundDefaultPolicy: SecurityGroupPolicy;
404
- /** Default outbound policy. */
578
+ /**
579
+ * Default outbound policy.
580
+ */
405
581
  outboundDefaultPolicy: SecurityGroupPolicy;
406
- /** Security group Organization ID. */
582
+ /**
583
+ * Security group Organization ID.
584
+ */
407
585
  organization: string;
408
- /** Security group Project ID. */
586
+ /**
587
+ * Security group Project ID.
588
+ */
409
589
  project: string;
410
- /** Security group tags. */
590
+ /**
591
+ * Security group tags.
592
+ */
411
593
  tags: string[];
412
594
  /**
413
- * @deprecated True if it is your default security group for this Organization
414
- * ID.
595
+ * @deprecated True if it is your default security group for this Organization ID.
415
596
  */
416
597
  organizationDefault?: boolean;
417
- /** True if it is your default security group for this Project ID. */
598
+ /**
599
+ * True if it is your default security group for this Project ID.
600
+ */
418
601
  projectDefault: boolean;
419
- /** Security group creation date. */
602
+ /**
603
+ * Security group creation date.
604
+ */
420
605
  creationDate?: Date;
421
- /** Security group modification date. */
606
+ /**
607
+ * Security group modification date.
608
+ */
422
609
  modificationDate?: Date;
423
- /** List of Instances attached to this security group. */
610
+ /**
611
+ * List of Instances attached to this security group.
612
+ */
424
613
  servers: ServerSummary[];
425
- /** Defines whether the security group is stateful. */
614
+ /**
615
+ * Defines whether the security group is stateful.
616
+ */
426
617
  stateful: boolean;
427
- /** Security group state. */
618
+ /**
619
+ * Security group state.
620
+ */
428
621
  state: SecurityGroupState;
429
- /** Zone in which the security group is located. */
622
+ /**
623
+ * Zone in which the security group is located.
624
+ */
430
625
  zone: ScwZone;
431
626
  }
432
627
  export interface SecurityGroupRule {
@@ -439,71 +634,129 @@ export interface SecurityGroupRule {
439
634
  destPortTo?: number;
440
635
  position: number;
441
636
  editable: boolean;
442
- /** Zone to target. If none is passed will use default zone from the config. */
637
+ /**
638
+ * Zone to target. If none is passed will use default zone from the config.
639
+ */
443
640
  zone: ScwZone;
444
641
  }
445
642
  export interface VolumeServerTemplate {
446
- /** UUID of the volume. */
643
+ /**
644
+ * UUID of the volume.
645
+ */
447
646
  id?: string;
448
- /** Force the Instance to boot on this volume. */
647
+ /**
648
+ * Force the Instance to boot on this volume.
649
+ */
449
650
  boot?: boolean;
450
- /** Name of the volume. */
651
+ /**
652
+ * Name of the volume.
653
+ */
451
654
  name?: string;
452
- /** Disk size of the volume, must be a multiple of 512. */
655
+ /**
656
+ * Disk size of the volume, must be a multiple of 512.
657
+ */
453
658
  size?: number;
454
- /** Type of the volume. */
659
+ /**
660
+ * Type of the volume.
661
+ */
455
662
  volumeType: VolumeVolumeType;
456
- /** ID of the snapshot on which this volume will be based. */
663
+ /**
664
+ * ID of the snapshot on which this volume will be based.
665
+ */
457
666
  baseSnapshot?: string;
458
- /** Organization ID of the volume. */
667
+ /**
668
+ * Organization ID of the volume.
669
+ */
459
670
  organization?: string;
460
- /** Project ID of the volume. */
671
+ /**
672
+ * Project ID of the volume.
673
+ */
461
674
  project?: string;
462
675
  }
463
676
  export interface Snapshot {
464
- /** Snapshot ID. */
677
+ /**
678
+ * Snapshot ID.
679
+ */
465
680
  id: string;
466
- /** Snapshot name. */
681
+ /**
682
+ * Snapshot name.
683
+ */
467
684
  name: string;
468
- /** Snapshot Organization ID. */
685
+ /**
686
+ * Snapshot Organization ID.
687
+ */
469
688
  organization: string;
470
- /** Snapshot Project ID. */
689
+ /**
690
+ * Snapshot Project ID.
691
+ */
471
692
  project: string;
472
- /** Snapshot tags. */
693
+ /**
694
+ * Snapshot tags.
695
+ */
473
696
  tags: string[];
474
- /** Snapshot volume type. */
697
+ /**
698
+ * Snapshot volume type.
699
+ */
475
700
  volumeType: VolumeVolumeType;
476
- /** Snapshot size. */
701
+ /**
702
+ * Snapshot size.
703
+ */
477
704
  size: number;
478
- /** Snapshot state. */
705
+ /**
706
+ * Snapshot state.
707
+ */
479
708
  state: SnapshotState;
480
- /** Volume on which the snapshot is based on. */
709
+ /**
710
+ * Volume on which the snapshot is based on.
711
+ */
481
712
  baseVolume?: SnapshotBaseVolume;
482
- /** Snapshot creation date. */
713
+ /**
714
+ * Snapshot creation date.
715
+ */
483
716
  creationDate?: Date;
484
- /** Snapshot modification date. */
717
+ /**
718
+ * Snapshot modification date.
719
+ */
485
720
  modificationDate?: Date;
486
- /** Snapshot zone. */
721
+ /**
722
+ * Snapshot zone.
723
+ */
487
724
  zone: ScwZone;
488
- /** Reason for the failed snapshot import. */
725
+ /**
726
+ * Reason for the failed snapshot import.
727
+ */
489
728
  errorReason?: string;
490
729
  }
491
730
  export interface Task {
492
- /** Unique ID of the task. */
731
+ /**
732
+ * Unique ID of the task.
733
+ */
493
734
  id: string;
494
- /** Description of the task. */
735
+ /**
736
+ * Description of the task.
737
+ */
495
738
  description: string;
496
- /** Progress of the task in percent. */
739
+ /**
740
+ * Progress of the task in percent.
741
+ */
497
742
  progress: number;
498
- /** Task start date. */
743
+ /**
744
+ * Task start date.
745
+ */
499
746
  startedAt?: Date;
500
- /** Task end date. */
747
+ /**
748
+ * Task end date.
749
+ */
501
750
  terminatedAt?: Date;
502
- /** Task status. */
751
+ /**
752
+ * Task status.
753
+ */
503
754
  status: TaskStatus;
504
755
  hrefFrom: string;
505
756
  hrefResult: string;
506
- /** Zone in which the task is excecuted. */
757
+ /**
758
+ * Zone in which the task is excecuted.
759
+ */
507
760
  zone: ScwZone;
508
761
  }
509
762
  export interface Dashboard {
@@ -517,58 +770,95 @@ export interface Dashboard {
517
770
  securityGroupsCount: number;
518
771
  ipsUnused: number;
519
772
  volumesLSsdCount: number;
520
- /** @deprecated */
773
+ /**
774
+ * @deprecated
775
+ */
521
776
  volumesBSsdCount?: number;
522
777
  volumesLSsdTotalSize: number;
523
- /** @deprecated */
778
+ /**
779
+ * @deprecated
780
+ */
524
781
  volumesBSsdTotalSize?: number;
525
782
  privateNicsCount: number;
526
783
  placementGroupsCount: number;
527
784
  }
528
785
  export interface PlacementGroupServer {
529
- /** Instance UUID. */
786
+ /**
787
+ * Instance UUID.
788
+ */
530
789
  id: string;
531
- /** Instance name. */
790
+ /**
791
+ * Instance name.
792
+ */
532
793
  name: string;
533
- /** Defines whether the placement group policy is respected (either 1 or 0). */
794
+ /**
795
+ * Defines whether the placement group policy is respected (either 1 or 0).
796
+ */
534
797
  policyRespected: boolean;
535
798
  }
536
799
  export interface GetServerTypesAvailabilityResponseAvailability {
537
800
  availability: ServerTypesAvailability;
538
801
  }
539
802
  export interface ServerType {
540
- /** @deprecated Estimated monthly price, for a 30 days month, in Euro. */
803
+ /**
804
+ * @deprecated Estimated monthly price, for a 30 days month, in Euro.
805
+ */
541
806
  monthlyPrice?: number;
542
- /** Hourly price in Euro. */
807
+ /**
808
+ * Hourly price in Euro.
809
+ */
543
810
  hourlyPrice: number;
544
- /** Alternative Instance name, if any. */
811
+ /**
812
+ * Alternative Instance name, if any.
813
+ */
545
814
  altNames: string[];
546
- /** Additional volume constraints. */
815
+ /**
816
+ * Additional volume constraints.
817
+ */
547
818
  perVolumeConstraint?: ServerTypeVolumeConstraintsByType;
548
- /** Initial volume constraints. */
819
+ /**
820
+ * Initial volume constraints.
821
+ */
549
822
  volumesConstraint?: ServerTypeVolumeConstraintSizes;
550
- /** Number of CPU. */
823
+ /**
824
+ * Number of CPU.
825
+ */
551
826
  ncpus: number;
552
- /** Number of GPU. */
827
+ /**
828
+ * Number of GPU.
829
+ */
553
830
  gpu?: number;
554
- /** Available RAM in bytes. */
831
+ /**
832
+ * Available RAM in bytes.
833
+ */
555
834
  ram: number;
556
- /** GPU information. */
835
+ /**
836
+ * GPU information.
837
+ */
557
838
  gpuInfo?: ServerTypeGPUInfo;
558
- /** CPU architecture. */
839
+ /**
840
+ * CPU architecture.
841
+ */
559
842
  arch: Arch;
560
- /** Network available for the Instance. */
843
+ /**
844
+ * Network available for the Instance.
845
+ */
561
846
  network?: ServerTypeNetwork;
562
- /** Capabilities. */
847
+ /**
848
+ * Capabilities.
849
+ */
563
850
  capabilities?: ServerTypeCapabilities;
564
- /** Maximum available scratch storage. */
851
+ /**
852
+ * Maximum available scratch storage.
853
+ */
565
854
  scratchStorageMaxSize?: number;
566
855
  /**
567
- * The maximum bandwidth allocated to block storage access (in bytes per
568
- * second).
856
+ * The maximum bandwidth allocated to block storage access (in bytes per second).
569
857
  */
570
858
  blockBandwidth?: number;
571
- /** True if this Instance type has reached end of service. */
859
+ /**
860
+ * True if this Instance type has reached end of service.
861
+ */
572
862
  endOfService: boolean;
573
863
  }
574
864
  export interface VolumeType {
@@ -578,51 +868,57 @@ export interface VolumeType {
578
868
  }
579
869
  export interface ServerActionRequestVolumeBackupTemplate {
580
870
  /**
581
- * Overrides the `volume_type` of the snapshot for this volume. If omitted,
582
- * the volume type of the original volume will be used.
871
+ * Overrides the `volume_type` of the snapshot for this volume.
872
+ If omitted, the volume type of the original volume will be used.
583
873
  */
584
874
  volumeType: SnapshotVolumeType;
585
875
  }
586
876
  export interface SetSecurityGroupRulesRequestRule {
587
877
  /**
588
- * UUID of the security rule to update. If no value is provided, a new rule
589
- * will be created.
878
+ * UUID of the security rule to update. If no value is provided, a new rule will be created.
590
879
  */
591
880
  id?: string;
592
- /** Action to apply when the rule matches a packet. */
881
+ /**
882
+ * Action to apply when the rule matches a packet.
883
+ */
593
884
  action: SecurityGroupRuleAction;
594
- /** Protocol family this rule applies to. */
885
+ /**
886
+ * Protocol family this rule applies to.
887
+ */
595
888
  protocol: SecurityGroupRuleProtocol;
596
- /** Direction the rule applies to. */
889
+ /**
890
+ * Direction the rule applies to.
891
+ */
597
892
  direction: SecurityGroupRuleDirection;
598
- /** Range of IP addresses these rules apply to. */
893
+ /**
894
+ * Range of IP addresses these rules apply to.
895
+ */
599
896
  ipRange: string;
600
897
  /**
601
- * Beginning of the range of ports this rule applies to (inclusive). This
602
- * value will be set to null if protocol is ICMP or ANY.
898
+ * Beginning of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY.
603
899
  */
604
900
  destPortFrom?: number;
605
901
  /**
606
- * End of the range of ports this rule applies to (inclusive). This value will
607
- * be set to null if protocol is ICMP or ANY, or if it is equal to
608
- * dest_port_from.
902
+ * End of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY, or if it is equal to dest_port_from.
609
903
  */
610
904
  destPortTo?: number;
611
905
  /**
612
- * Position of this rule in the security group rules list. If several rules
613
- * are passed with the same position, the resulting order is undefined.
906
+ * Position of this rule in the security group rules list. If several rules are passed with the same position, the resulting order is undefined.
614
907
  */
615
908
  position: number;
616
909
  /**
617
- * Indicates if this rule is editable. Rules with the value false will be
618
- * ignored.
910
+ * Indicates if this rule is editable. Rules with the value false will be ignored.
619
911
  */
620
912
  editable?: boolean;
621
- /** Zone of the rule. This field is ignored. */
913
+ /**
914
+ * Zone of the rule. This field is ignored.
915
+ */
622
916
  zone?: ScwZone;
623
917
  }
624
918
  export interface VolumeImageUpdateTemplate {
625
- /** UUID of the snapshot. */
919
+ /**
920
+ * UUID of the snapshot.
921
+ */
626
922
  id: string;
627
923
  }
628
924
  export interface SecurityGroupTemplate {
@@ -630,36 +926,31 @@ export interface SecurityGroupTemplate {
630
926
  name: string;
631
927
  }
632
928
  export type ApplyBlockMigrationRequest = {
633
- /** Zone to target. If none is passed will use default zone from the config. */
929
+ /**
930
+ * Zone to target. If none is passed will use default zone from the config.
931
+ */
634
932
  zone?: ScwZone;
635
933
  /**
636
- * The volume to migrate, along with potentially other resources, according to
637
- * the migration plan generated with a call to the [Get a volume or snapshot's
638
- * migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan)
639
- * endpoint.
934
+ * The volume to migrate, along with potentially other resources, according to the migration plan generated with a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint.
640
935
  *
641
936
  * One-of ('resource'): at most one of 'volumeId', 'snapshotId' could be set.
642
937
  */
643
938
  volumeId?: string;
644
939
  /**
645
- * The snapshot to migrate, along with potentially other resources, according
646
- * to the migration plan generated with a call to the [Get a volume or
647
- * snapshot's migration
648
- * plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint.
940
+ * The snapshot to migrate, along with potentially other resources, according to the migration plan generated with a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint.
649
941
  *
650
942
  * One-of ('resource'): at most one of 'volumeId', 'snapshotId' could be set.
651
943
  */
652
944
  snapshotId?: string;
653
945
  /**
654
- * A value to be retrieved from a call to the [Get a volume or snapshot's
655
- * migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan)
656
- * endpoint, to confirm that the volume and/or snapshots specified in said
657
- * plan should be migrated.
946
+ * A value to be retrieved from a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint, to confirm that the volume and/or snapshots specified in said plan should be migrated.
658
947
  */
659
948
  validationKey: string;
660
949
  };
661
950
  export type AttachServerVolumeRequest = {
662
- /** Zone to target. If none is passed will use default zone from the config. */
951
+ /**
952
+ * Zone to target. If none is passed will use default zone from the config.
953
+ */
663
954
  zone?: ScwZone;
664
955
  serverId: string;
665
956
  volumeId: string;
@@ -670,113 +961,150 @@ export interface AttachServerVolumeResponse {
670
961
  server?: Server;
671
962
  }
672
963
  export type CheckBlockMigrationOrganizationQuotasRequest = {
673
- /** Zone to target. If none is passed will use default zone from the config. */
964
+ /**
965
+ * Zone to target. If none is passed will use default zone from the config.
966
+ */
674
967
  zone?: ScwZone;
675
968
  organization?: string;
676
969
  };
677
970
  export type CreateImageRequest = {
678
- /** Zone to target. If none is passed will use default zone from the config. */
971
+ /**
972
+ * Zone to target. If none is passed will use default zone from the config.
973
+ */
679
974
  zone?: ScwZone;
680
- /** Name of the image. */
975
+ /**
976
+ * Name of the image.
977
+ */
681
978
  name?: string;
682
- /** UUID of the snapshot. */
979
+ /**
980
+ * UUID of the snapshot.
981
+ */
683
982
  rootVolume: string;
684
- /** Architecture of the image. */
983
+ /**
984
+ * Architecture of the image.
985
+ */
685
986
  arch: Arch;
686
- /** Additional volumes of the image. */
987
+ /**
988
+ * Additional volumes of the image.
989
+ */
687
990
  extraVolumes?: Record<string, VolumeTemplate>;
688
991
  /**
689
992
  * @deprecated Organization ID of the image.
690
993
  *
691
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
692
- * could be set.
994
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
693
995
  */
694
996
  organization?: string;
695
997
  /**
696
998
  * Project ID of the image.
697
999
  *
698
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
699
- * could be set.
1000
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
700
1001
  */
701
1002
  project?: string;
702
- /** Tags of the image. */
1003
+ /**
1004
+ * Tags of the image.
1005
+ */
703
1006
  tags?: string[];
704
- /** True to create a public image. */
1007
+ /**
1008
+ * True to create a public image.
1009
+ */
705
1010
  public?: boolean;
706
1011
  };
707
1012
  export interface CreateImageResponse {
708
1013
  image?: Image;
709
1014
  }
710
1015
  export type CreateIpRequest = {
711
- /** Zone to target. If none is passed will use default zone from the config. */
1016
+ /**
1017
+ * Zone to target. If none is passed will use default zone from the config.
1018
+ */
712
1019
  zone?: ScwZone;
713
1020
  /**
714
1021
  * @deprecated Organization ID in which the IP is reserved.
715
1022
  *
716
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
717
- * could be set.
1023
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
718
1024
  */
719
1025
  organization?: string;
720
1026
  /**
721
1027
  * Project ID in which the IP is reserved.
722
1028
  *
723
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
724
- * could be set.
1029
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
725
1030
  */
726
1031
  project?: string;
727
- /** Tags of the IP. */
1032
+ /**
1033
+ * Tags of the IP.
1034
+ */
728
1035
  tags?: string[];
729
- /** UUID of the Instance you want to attach the IP to. */
1036
+ /**
1037
+ * UUID of the Instance you want to attach the IP to.
1038
+ */
730
1039
  server?: string;
731
- /** IP type to reserve (either 'routed_ipv4' or 'routed_ipv6'). */
1040
+ /**
1041
+ * IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').
1042
+ */
732
1043
  type?: IpType;
733
1044
  };
734
1045
  export interface CreateIpResponse {
735
1046
  ip?: Ip;
736
1047
  }
737
1048
  export type CreatePlacementGroupRequest = {
738
- /** Zone to target. If none is passed will use default zone from the config. */
1049
+ /**
1050
+ * Zone to target. If none is passed will use default zone from the config.
1051
+ */
739
1052
  zone?: ScwZone;
740
- /** Name of the placement group. */
1053
+ /**
1054
+ * Name of the placement group.
1055
+ */
741
1056
  name?: string;
742
1057
  /**
743
1058
  * @deprecated Organization ID of the placement group.
744
1059
  *
745
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
746
- * could be set.
1060
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
747
1061
  */
748
1062
  organization?: string;
749
1063
  /**
750
1064
  * Project ID of the placement group.
751
1065
  *
752
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
753
- * could be set.
1066
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
754
1067
  */
755
1068
  project?: string;
756
- /** Tags of the placement group. */
1069
+ /**
1070
+ * Tags of the placement group.
1071
+ */
757
1072
  tags?: string[];
758
- /** Operating mode of the placement group. */
1073
+ /**
1074
+ * Operating mode of the placement group.
1075
+ */
759
1076
  policyMode?: PlacementGroupPolicyMode;
760
- /** Policy type of the placement group. */
1077
+ /**
1078
+ * Policy type of the placement group.
1079
+ */
761
1080
  policyType?: PlacementGroupPolicyType;
762
1081
  };
763
1082
  export interface CreatePlacementGroupResponse {
764
1083
  placementGroup?: PlacementGroup;
765
1084
  }
766
1085
  export type CreatePrivateNICRequest = {
767
- /** Zone to target. If none is passed will use default zone from the config. */
1086
+ /**
1087
+ * Zone to target. If none is passed will use default zone from the config.
1088
+ */
768
1089
  zone?: ScwZone;
769
- /** UUID of the Instance the private NIC will be attached to. */
1090
+ /**
1091
+ * UUID of the Instance the private NIC will be attached to.
1092
+ */
770
1093
  serverId: string;
771
- /** UUID of the private network where the private NIC will be attached. */
1094
+ /**
1095
+ * UUID of the private network where the private NIC will be attached.
1096
+ */
772
1097
  privateNetworkId: string;
773
- /** Private NIC tags. */
1098
+ /**
1099
+ * Private NIC tags.
1100
+ */
774
1101
  tags?: string[];
775
- /** @deprecated Ip_ids defined from IPAM. */
1102
+ /**
1103
+ * @deprecated Ip_ids defined from IPAM.
1104
+ */
776
1105
  ipIds?: string[];
777
1106
  /**
778
- * UUID of IPAM ips, to be attached to the instance in the requested private
779
- * network.
1107
+ * UUID of IPAM ips, to be attached to the instance in the requested private network.
780
1108
  */
781
1109
  ipamIpIds?: string[];
782
1110
  };
@@ -784,53 +1112,60 @@ export interface CreatePrivateNICResponse {
784
1112
  privateNic?: PrivateNIC;
785
1113
  }
786
1114
  export type CreateSecurityGroupRequest = {
787
- /** Zone to target. If none is passed will use default zone from the config. */
1115
+ /**
1116
+ * Zone to target. If none is passed will use default zone from the config.
1117
+ */
788
1118
  zone?: ScwZone;
789
- /** Name of the security group. */
1119
+ /**
1120
+ * Name of the security group.
1121
+ */
790
1122
  name?: string;
791
- /** Description of the security group. */
1123
+ /**
1124
+ * Description of the security group.
1125
+ */
792
1126
  description: string;
793
1127
  /**
794
1128
  * @deprecated Organization ID the security group belongs to.
795
1129
  *
796
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
797
- * could be set.
1130
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
798
1131
  */
799
1132
  organization?: string;
800
1133
  /**
801
1134
  * Project ID the security group belong to.
802
1135
  *
803
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
804
- * could be set.
1136
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
805
1137
  */
806
1138
  project?: string;
807
- /** Tags of the security group. */
1139
+ /**
1140
+ * Tags of the security group.
1141
+ */
808
1142
  tags?: string[];
809
1143
  /**
810
- * @deprecated Defines whether this security group becomes the default
811
- * security group for new Instances.
1144
+ * @deprecated Defines whether this security group becomes the default security group for new Instances.
812
1145
  *
813
- * One-of ('defaultIdentifier'): at most one of 'organizationDefault',
814
- * 'projectDefault' could be set.
1146
+ * One-of ('defaultIdentifier'): at most one of 'organizationDefault', 'projectDefault' could be set.
815
1147
  */
816
1148
  organizationDefault?: boolean;
817
1149
  /**
818
- * Whether this security group becomes the default security group for new
819
- * Instances.
1150
+ * Whether this security group becomes the default security group for new Instances.
820
1151
  *
821
- * One-of ('defaultIdentifier'): at most one of 'organizationDefault',
822
- * 'projectDefault' could be set.
1152
+ * One-of ('defaultIdentifier'): at most one of 'organizationDefault', 'projectDefault' could be set.
823
1153
  */
824
1154
  projectDefault?: boolean;
825
- /** Whether the security group is stateful or not. */
1155
+ /**
1156
+ * Whether the security group is stateful or not.
1157
+ */
826
1158
  stateful: boolean;
827
- /** Default policy for inbound rules. */
1159
+ /**
1160
+ * Default policy for inbound rules.
1161
+ */
828
1162
  inboundDefaultPolicy?: SecurityGroupPolicy;
829
- /** Default policy for outbound rules. */
1163
+ /**
1164
+ * Default policy for outbound rules.
1165
+ */
830
1166
  outboundDefaultPolicy?: SecurityGroupPolicy;
831
1167
  /**
832
- * True to block SMTP on IPv4 and IPv6. This feature is read only, please open
833
- * a support ticket if you need to make it configurable.
1168
+ * True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
834
1169
  */
835
1170
  enableDefaultSecurity?: boolean;
836
1171
  };
@@ -838,114 +1173,160 @@ export interface CreateSecurityGroupResponse {
838
1173
  securityGroup?: SecurityGroup;
839
1174
  }
840
1175
  export type CreateSecurityGroupRuleRequest = {
841
- /** Zone to target. If none is passed will use default zone from the config. */
1176
+ /**
1177
+ * Zone to target. If none is passed will use default zone from the config.
1178
+ */
842
1179
  zone?: ScwZone;
843
- /** UUID of the security group. */
1180
+ /**
1181
+ * UUID of the security group.
1182
+ */
844
1183
  securityGroupId: string;
845
1184
  protocol: SecurityGroupRuleProtocol;
846
1185
  direction: SecurityGroupRuleDirection;
847
1186
  action: SecurityGroupRuleAction;
848
1187
  ipRange: string;
849
- /** Beginning of the range of ports to apply this rule to (inclusive). */
1188
+ /**
1189
+ * Beginning of the range of ports to apply this rule to (inclusive).
1190
+ */
850
1191
  destPortFrom?: number;
851
- /** End of the range of ports to apply this rule to (inclusive). */
1192
+ /**
1193
+ * End of the range of ports to apply this rule to (inclusive).
1194
+ */
852
1195
  destPortTo?: number;
853
- /** Position of this rule in the security group rules list. */
1196
+ /**
1197
+ * Position of this rule in the security group rules list.
1198
+ */
854
1199
  position: number;
855
- /** Indicates if this rule is editable (will be ignored). */
1200
+ /**
1201
+ * Indicates if this rule is editable (will be ignored).
1202
+ */
856
1203
  editable: boolean;
857
1204
  };
858
1205
  export interface CreateSecurityGroupRuleResponse {
859
1206
  rule?: SecurityGroupRule;
860
1207
  }
861
1208
  export type CreateServerRequest = {
862
- /** Zone to target. If none is passed will use default zone from the config. */
1209
+ /**
1210
+ * Zone to target. If none is passed will use default zone from the config.
1211
+ */
863
1212
  zone?: ScwZone;
864
- /** Instance name. */
1213
+ /**
1214
+ * Instance name.
1215
+ */
865
1216
  name?: string;
866
- /** Define if a dynamic IPv4 is required for the Instance. */
1217
+ /**
1218
+ * Define if a dynamic IPv4 is required for the Instance.
1219
+ */
867
1220
  dynamicIpRequired?: boolean;
868
1221
  /**
869
- * @deprecated If true, configure the Instance so it uses the new routed IP
870
- * mode.
1222
+ * @deprecated If true, configure the Instance so it uses the new routed IP mode.
871
1223
  */
872
1224
  routedIpEnabled?: boolean;
873
- /** Define the Instance commercial type (i.e. GP1-S). */
1225
+ /**
1226
+ * Define the Instance commercial type (i.e. GP1-S).
1227
+ */
874
1228
  commercialType: string;
875
- /** Instance image ID or label. */
1229
+ /**
1230
+ * Instance image ID or label.
1231
+ */
876
1232
  image?: string;
877
- /** Volumes attached to the server. */
1233
+ /**
1234
+ * Volumes attached to the server.
1235
+ */
878
1236
  volumes?: Record<string, VolumeServerTemplate>;
879
1237
  /**
880
- * @deprecated True if IPv6 is enabled on the server (deprecated and always
881
- * `False` when `routed_ip_enabled` is `True`).
1238
+ * @deprecated True if IPv6 is enabled on the server (deprecated and always `False` when `routed_ip_enabled` is `True`).
882
1239
  */
883
1240
  enableIpv6?: boolean;
884
- /** @deprecated ID of the reserved IP to attach to the Instance. */
1241
+ /**
1242
+ * @deprecated ID of the reserved IP to attach to the Instance.
1243
+ */
885
1244
  publicIp?: string;
886
- /** A list of reserved IP IDs to attach to the Instance. */
1245
+ /**
1246
+ * A list of reserved IP IDs to attach to the Instance.
1247
+ */
887
1248
  publicIps?: string[];
888
- /** Boot type to use. */
1249
+ /**
1250
+ * Boot type to use.
1251
+ */
889
1252
  bootType?: BootType;
890
1253
  /**
891
1254
  * @deprecated Instance Organization ID.
892
1255
  *
893
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
894
- * could be set.
1256
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
895
1257
  */
896
1258
  organization?: string;
897
1259
  /**
898
1260
  * Instance Project ID.
899
1261
  *
900
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
901
- * could be set.
1262
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
902
1263
  */
903
1264
  project?: string;
904
- /** Instance tags. */
1265
+ /**
1266
+ * Instance tags.
1267
+ */
905
1268
  tags?: string[];
906
- /** Security group ID. */
1269
+ /**
1270
+ * Security group ID.
1271
+ */
907
1272
  securityGroup?: string;
908
- /** Placement group ID if Instance must be part of a placement group. */
1273
+ /**
1274
+ * Placement group ID if Instance must be part of a placement group.
1275
+ */
909
1276
  placementGroup?: string;
910
- /** The public_key value of this key is used to encrypt the admin password. */
1277
+ /**
1278
+ * The public_key value of this key is used to encrypt the admin password.
1279
+ */
911
1280
  adminPasswordEncryptionSshKeyId?: string;
912
1281
  };
913
1282
  export interface CreateServerResponse {
914
1283
  server?: Server;
915
1284
  }
916
1285
  export type CreateSnapshotRequest = {
917
- /** Zone to target. If none is passed will use default zone from the config. */
1286
+ /**
1287
+ * Zone to target. If none is passed will use default zone from the config.
1288
+ */
918
1289
  zone?: ScwZone;
919
- /** Name of the snapshot. */
1290
+ /**
1291
+ * Name of the snapshot.
1292
+ */
920
1293
  name?: string;
921
- /** UUID of the volume. */
1294
+ /**
1295
+ * UUID of the volume.
1296
+ */
922
1297
  volumeId?: string;
923
- /** Tags of the snapshot. */
1298
+ /**
1299
+ * Tags of the snapshot.
1300
+ */
924
1301
  tags?: string[];
925
1302
  /**
926
1303
  * @deprecated Organization ID of the snapshot.
927
1304
  *
928
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
929
- * could be set.
1305
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
930
1306
  */
931
1307
  organization?: string;
932
1308
  /**
933
1309
  * Project ID of the snapshot.
934
1310
  *
935
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
936
- * could be set.
1311
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
937
1312
  */
938
1313
  project?: string;
939
1314
  /**
940
- * Overrides the volume_type of the snapshot. If omitted, the volume type of
941
- * the original volume will be used.
1315
+ * Overrides the volume_type of the snapshot.
1316
+ If omitted, the volume type of the original volume will be used.
942
1317
  */
943
1318
  volumeType?: SnapshotVolumeType;
944
- /** Bucket name for snapshot imports. */
1319
+ /**
1320
+ * Bucket name for snapshot imports.
1321
+ */
945
1322
  bucket?: string;
946
- /** Object key for snapshot imports. */
1323
+ /**
1324
+ * Object key for snapshot imports.
1325
+ */
947
1326
  key?: string;
948
- /** Imported snapshot size, must be a multiple of 512. */
1327
+ /**
1328
+ * Imported snapshot size, must be a multiple of 512.
1329
+ */
949
1330
  size?: number;
950
1331
  };
951
1332
  export interface CreateSnapshotResponse {
@@ -953,27 +1334,33 @@ export interface CreateSnapshotResponse {
953
1334
  task?: Task;
954
1335
  }
955
1336
  export type CreateVolumeRequest = {
956
- /** Zone to target. If none is passed will use default zone from the config. */
1337
+ /**
1338
+ * Zone to target. If none is passed will use default zone from the config.
1339
+ */
957
1340
  zone?: ScwZone;
958
- /** Volume name. */
1341
+ /**
1342
+ * Volume name.
1343
+ */
959
1344
  name?: string;
960
1345
  /**
961
1346
  * @deprecated Volume Organization ID.
962
1347
  *
963
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
964
- * could be set.
1348
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
965
1349
  */
966
1350
  organization?: string;
967
1351
  /**
968
1352
  * Volume Project ID.
969
1353
  *
970
- * One-of ('projectIdentifier'): at most one of 'project', 'organization'
971
- * could be set.
1354
+ * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set.
972
1355
  */
973
1356
  project?: string;
974
- /** Volume tags. */
1357
+ /**
1358
+ * Volume tags.
1359
+ */
975
1360
  tags?: string[];
976
- /** Volume type. */
1361
+ /**
1362
+ * Volume type.
1363
+ */
977
1364
  volumeType?: VolumeVolumeType;
978
1365
  /**
979
1366
  * Volume disk size, must be a multiple of 512.
@@ -992,70 +1379,112 @@ export interface CreateVolumeResponse {
992
1379
  volume?: Volume;
993
1380
  }
994
1381
  export type DeleteImageRequest = {
995
- /** Zone to target. If none is passed will use default zone from the config. */
1382
+ /**
1383
+ * Zone to target. If none is passed will use default zone from the config.
1384
+ */
996
1385
  zone?: ScwZone;
997
- /** UUID of the image you want to delete. */
1386
+ /**
1387
+ * UUID of the image you want to delete.
1388
+ */
998
1389
  imageId: string;
999
1390
  };
1000
1391
  export type DeleteIpRequest = {
1001
- /** Zone to target. If none is passed will use default zone from the config. */
1392
+ /**
1393
+ * Zone to target. If none is passed will use default zone from the config.
1394
+ */
1002
1395
  zone?: ScwZone;
1003
- /** ID or address of the IP to delete. */
1396
+ /**
1397
+ * ID or address of the IP to delete.
1398
+ */
1004
1399
  ip: string;
1005
1400
  };
1006
1401
  export type DeletePlacementGroupRequest = {
1007
- /** Zone to target. If none is passed will use default zone from the config. */
1402
+ /**
1403
+ * Zone to target. If none is passed will use default zone from the config.
1404
+ */
1008
1405
  zone?: ScwZone;
1009
- /** UUID of the placement group you want to delete. */
1406
+ /**
1407
+ * UUID of the placement group you want to delete.
1408
+ */
1010
1409
  placementGroupId: string;
1011
1410
  };
1012
1411
  export type DeletePrivateNICRequest = {
1013
- /** Zone to target. If none is passed will use default zone from the config. */
1412
+ /**
1413
+ * Zone to target. If none is passed will use default zone from the config.
1414
+ */
1014
1415
  zone?: ScwZone;
1015
- /** Instance to which the private NIC is attached. */
1416
+ /**
1417
+ * Instance to which the private NIC is attached.
1418
+ */
1016
1419
  serverId: string;
1017
- /** Private NIC unique ID. */
1420
+ /**
1421
+ * Private NIC unique ID.
1422
+ */
1018
1423
  privateNicId: string;
1019
1424
  };
1020
1425
  export type DeleteSecurityGroupRequest = {
1021
- /** Zone to target. If none is passed will use default zone from the config. */
1426
+ /**
1427
+ * Zone to target. If none is passed will use default zone from the config.
1428
+ */
1022
1429
  zone?: ScwZone;
1023
- /** UUID of the security group you want to delete. */
1430
+ /**
1431
+ * UUID of the security group you want to delete.
1432
+ */
1024
1433
  securityGroupId: string;
1025
1434
  };
1026
1435
  export type DeleteSecurityGroupRuleRequest = {
1027
- /** Zone to target. If none is passed will use default zone from the config. */
1436
+ /**
1437
+ * Zone to target. If none is passed will use default zone from the config.
1438
+ */
1028
1439
  zone?: ScwZone;
1029
1440
  securityGroupId: string;
1030
1441
  securityGroupRuleId: string;
1031
1442
  };
1032
1443
  export type DeleteServerRequest = {
1033
- /** Zone to target. If none is passed will use default zone from the config. */
1444
+ /**
1445
+ * Zone to target. If none is passed will use default zone from the config.
1446
+ */
1034
1447
  zone?: ScwZone;
1035
1448
  serverId: string;
1036
1449
  };
1037
1450
  export type DeleteServerUserDataRequest = {
1038
- /** Zone to target. If none is passed will use default zone from the config. */
1451
+ /**
1452
+ * Zone to target. If none is passed will use default zone from the config.
1453
+ */
1039
1454
  zone?: ScwZone;
1040
- /** UUID of the Instance. */
1455
+ /**
1456
+ * UUID of the Instance.
1457
+ */
1041
1458
  serverId: string;
1042
- /** Key of the user data to delete. */
1459
+ /**
1460
+ * Key of the user data to delete.
1461
+ */
1043
1462
  key: string;
1044
1463
  };
1045
1464
  export type DeleteSnapshotRequest = {
1046
- /** Zone to target. If none is passed will use default zone from the config. */
1465
+ /**
1466
+ * Zone to target. If none is passed will use default zone from the config.
1467
+ */
1047
1468
  zone?: ScwZone;
1048
- /** UUID of the snapshot you want to delete. */
1469
+ /**
1470
+ * UUID of the snapshot you want to delete.
1471
+ */
1049
1472
  snapshotId: string;
1050
1473
  };
1051
1474
  export type DeleteVolumeRequest = {
1052
- /** Zone to target. If none is passed will use default zone from the config. */
1475
+ /**
1476
+ * Zone to target. If none is passed will use default zone from the config.
1477
+ */
1053
1478
  zone?: ScwZone;
1054
- /** UUID of the volume you want to delete. */
1479
+ /**
1480
+ * UUID of the volume you want to delete.
1481
+ */
1055
1482
  volumeId: string;
1056
1483
  };
1057
1484
  export type DetachServerVolumeRequest = {
1058
- /** Zone to target. If none is passed will use default zone from the config. */
1485
+ /**
1486
+ * Zone to target. If none is passed will use default zone from the config.
1487
+ */
1059
1488
  zone?: ScwZone;
1060
1489
  serverId: string;
1061
1490
  volumeId: string;
@@ -1064,20 +1493,30 @@ export interface DetachServerVolumeResponse {
1064
1493
  server?: Server;
1065
1494
  }
1066
1495
  export type ExportSnapshotRequest = {
1067
- /** Zone to target. If none is passed will use default zone from the config. */
1496
+ /**
1497
+ * Zone to target. If none is passed will use default zone from the config.
1498
+ */
1068
1499
  zone?: ScwZone;
1069
- /** Snapshot ID. */
1500
+ /**
1501
+ * Snapshot ID.
1502
+ */
1070
1503
  snapshotId: string;
1071
- /** Object Storage bucket name. */
1504
+ /**
1505
+ * Object Storage bucket name.
1506
+ */
1072
1507
  bucket: string;
1073
- /** Object key. */
1508
+ /**
1509
+ * Object key.
1510
+ */
1074
1511
  key: string;
1075
1512
  };
1076
1513
  export interface ExportSnapshotResponse {
1077
1514
  task?: Task;
1078
1515
  }
1079
1516
  export type GetDashboardRequest = {
1080
- /** Zone to target. If none is passed will use default zone from the config. */
1517
+ /**
1518
+ * Zone to target. If none is passed will use default zone from the config.
1519
+ */
1081
1520
  zone?: ScwZone;
1082
1521
  organization?: string;
1083
1522
  project?: string;
@@ -1086,64 +1525,94 @@ export interface GetDashboardResponse {
1086
1525
  dashboard?: Dashboard;
1087
1526
  }
1088
1527
  export type GetImageRequest = {
1089
- /** Zone to target. If none is passed will use default zone from the config. */
1528
+ /**
1529
+ * Zone to target. If none is passed will use default zone from the config.
1530
+ */
1090
1531
  zone?: ScwZone;
1091
- /** UUID of the image you want to get. */
1532
+ /**
1533
+ * UUID of the image you want to get.
1534
+ */
1092
1535
  imageId: string;
1093
1536
  };
1094
1537
  export interface GetImageResponse {
1095
1538
  image?: Image;
1096
1539
  }
1097
1540
  export type GetIpRequest = {
1098
- /** Zone to target. If none is passed will use default zone from the config. */
1541
+ /**
1542
+ * Zone to target. If none is passed will use default zone from the config.
1543
+ */
1099
1544
  zone?: ScwZone;
1100
- /** IP ID or address to get. */
1545
+ /**
1546
+ * IP ID or address to get.
1547
+ */
1101
1548
  ip: string;
1102
1549
  };
1103
1550
  export interface GetIpResponse {
1104
1551
  ip?: Ip;
1105
1552
  }
1106
1553
  export type GetPlacementGroupRequest = {
1107
- /** Zone to target. If none is passed will use default zone from the config. */
1554
+ /**
1555
+ * Zone to target. If none is passed will use default zone from the config.
1556
+ */
1108
1557
  zone?: ScwZone;
1109
- /** UUID of the placement group you want to get. */
1558
+ /**
1559
+ * UUID of the placement group you want to get.
1560
+ */
1110
1561
  placementGroupId: string;
1111
1562
  };
1112
1563
  export interface GetPlacementGroupResponse {
1113
1564
  placementGroup?: PlacementGroup;
1114
1565
  }
1115
1566
  export type GetPlacementGroupServersRequest = {
1116
- /** Zone to target. If none is passed will use default zone from the config. */
1567
+ /**
1568
+ * Zone to target. If none is passed will use default zone from the config.
1569
+ */
1117
1570
  zone?: ScwZone;
1118
- /** UUID of the placement group you want to get. */
1571
+ /**
1572
+ * UUID of the placement group you want to get.
1573
+ */
1119
1574
  placementGroupId: string;
1120
1575
  };
1121
1576
  export interface GetPlacementGroupServersResponse {
1122
- /** Instances attached to the placement group. */
1577
+ /**
1578
+ * Instances attached to the placement group.
1579
+ */
1123
1580
  servers: PlacementGroupServer[];
1124
1581
  }
1125
1582
  export type GetPrivateNICRequest = {
1126
- /** Zone to target. If none is passed will use default zone from the config. */
1583
+ /**
1584
+ * Zone to target. If none is passed will use default zone from the config.
1585
+ */
1127
1586
  zone?: ScwZone;
1128
- /** Instance to which the private NIC is attached. */
1587
+ /**
1588
+ * Instance to which the private NIC is attached.
1589
+ */
1129
1590
  serverId: string;
1130
- /** Private NIC unique ID. */
1591
+ /**
1592
+ * Private NIC unique ID.
1593
+ */
1131
1594
  privateNicId: string;
1132
1595
  };
1133
1596
  export interface GetPrivateNICResponse {
1134
1597
  privateNic?: PrivateNIC;
1135
1598
  }
1136
1599
  export type GetSecurityGroupRequest = {
1137
- /** Zone to target. If none is passed will use default zone from the config. */
1600
+ /**
1601
+ * Zone to target. If none is passed will use default zone from the config.
1602
+ */
1138
1603
  zone?: ScwZone;
1139
- /** UUID of the security group you want to get. */
1604
+ /**
1605
+ * UUID of the security group you want to get.
1606
+ */
1140
1607
  securityGroupId: string;
1141
1608
  };
1142
1609
  export interface GetSecurityGroupResponse {
1143
1610
  securityGroup?: SecurityGroup;
1144
1611
  }
1145
1612
  export type GetSecurityGroupRuleRequest = {
1146
- /** Zone to target. If none is passed will use default zone from the config. */
1613
+ /**
1614
+ * Zone to target. If none is passed will use default zone from the config.
1615
+ */
1147
1616
  zone?: ScwZone;
1148
1617
  securityGroupId: string;
1149
1618
  securityGroupRuleId: string;
@@ -1152,60 +1621,85 @@ export interface GetSecurityGroupRuleResponse {
1152
1621
  rule?: SecurityGroupRule;
1153
1622
  }
1154
1623
  export type GetServerCompatibleTypesRequest = {
1155
- /** Zone to target. If none is passed will use default zone from the config. */
1624
+ /**
1625
+ * Zone to target. If none is passed will use default zone from the config.
1626
+ */
1156
1627
  zone?: ScwZone;
1157
- /** UUID of the Instance you want to get. */
1628
+ /**
1629
+ * UUID of the Instance you want to get.
1630
+ */
1158
1631
  serverId: string;
1159
1632
  };
1160
1633
  export type GetServerRequest = {
1161
- /** Zone to target. If none is passed will use default zone from the config. */
1634
+ /**
1635
+ * Zone to target. If none is passed will use default zone from the config.
1636
+ */
1162
1637
  zone?: ScwZone;
1163
- /** UUID of the Instance you want to get. */
1638
+ /**
1639
+ * UUID of the Instance you want to get.
1640
+ */
1164
1641
  serverId: string;
1165
1642
  };
1166
1643
  export interface GetServerResponse {
1167
1644
  server?: Server;
1168
1645
  }
1169
1646
  export type GetServerTypesAvailabilityRequest = {
1170
- /** Zone to target. If none is passed will use default zone from the config. */
1647
+ /**
1648
+ * Zone to target. If none is passed will use default zone from the config.
1649
+ */
1171
1650
  zone?: ScwZone;
1172
1651
  /**
1173
- * A positive integer lower or equal to 100 to select the number of items to
1174
- * return.
1652
+ * A positive integer lower or equal to 100 to select the number of items to return.
1175
1653
  */
1176
1654
  perPage?: number;
1177
- /** A positive integer to choose the page to return. */
1655
+ /**
1656
+ * A positive integer to choose the page to return.
1657
+ */
1178
1658
  page?: number;
1179
1659
  };
1180
1660
  export interface GetServerTypesAvailabilityResponse {
1181
- /** Map of server types. */
1661
+ /**
1662
+ * Map of server types.
1663
+ */
1182
1664
  servers: Record<string, GetServerTypesAvailabilityResponseAvailability>;
1183
1665
  totalCount: number;
1184
1666
  }
1185
1667
  export type GetSnapshotRequest = {
1186
- /** Zone to target. If none is passed will use default zone from the config. */
1668
+ /**
1669
+ * Zone to target. If none is passed will use default zone from the config.
1670
+ */
1187
1671
  zone?: ScwZone;
1188
- /** UUID of the snapshot you want to get. */
1672
+ /**
1673
+ * UUID of the snapshot you want to get.
1674
+ */
1189
1675
  snapshotId: string;
1190
1676
  };
1191
1677
  export interface GetSnapshotResponse {
1192
1678
  snapshot?: Snapshot;
1193
1679
  }
1194
1680
  export type GetVolumeRequest = {
1195
- /** Zone to target. If none is passed will use default zone from the config. */
1681
+ /**
1682
+ * Zone to target. If none is passed will use default zone from the config.
1683
+ */
1196
1684
  zone?: ScwZone;
1197
- /** UUID of the volume you want to get. */
1685
+ /**
1686
+ * UUID of the volume you want to get.
1687
+ */
1198
1688
  volumeId: string;
1199
1689
  };
1200
1690
  export interface GetVolumeResponse {
1201
1691
  volume?: Volume;
1202
1692
  }
1203
1693
  export type ListDefaultSecurityGroupRulesRequest = {
1204
- /** Zone to target. If none is passed will use default zone from the config. */
1694
+ /**
1695
+ * Zone to target. If none is passed will use default zone from the config.
1696
+ */
1205
1697
  zone?: ScwZone;
1206
1698
  };
1207
1699
  export type ListImagesRequest = {
1208
- /** Zone to target. If none is passed will use default zone from the config. */
1700
+ /**
1701
+ * Zone to target. If none is passed will use default zone from the config.
1702
+ */
1209
1703
  zone?: ScwZone;
1210
1704
  organization?: string;
1211
1705
  perPage?: number;
@@ -1217,88 +1711,119 @@ export type ListImagesRequest = {
1217
1711
  tags?: string;
1218
1712
  };
1219
1713
  export interface ListImagesResponse {
1220
- /** Total number of images. */
1714
+ /**
1715
+ * Total number of images.
1716
+ */
1221
1717
  totalCount: number;
1222
- /** List of images. */
1718
+ /**
1719
+ * List of images.
1720
+ */
1223
1721
  images: Image[];
1224
1722
  }
1225
1723
  export type ListIpsRequest = {
1226
- /** Zone to target. If none is passed will use default zone from the config. */
1724
+ /**
1725
+ * Zone to target. If none is passed will use default zone from the config.
1726
+ */
1227
1727
  zone?: ScwZone;
1228
- /** Project ID in which the IPs are reserved. */
1728
+ /**
1729
+ * Project ID in which the IPs are reserved.
1730
+ */
1229
1731
  project?: string;
1230
- /** Organization ID in which the IPs are reserved. */
1732
+ /**
1733
+ * Organization ID in which the IPs are reserved.
1734
+ */
1231
1735
  organization?: string;
1232
1736
  /**
1233
- * Filter IPs with these exact tags (to filter with several tags, use commas
1234
- * to separate them).
1737
+ * Filter IPs with these exact tags (to filter with several tags, use commas to separate them).
1235
1738
  */
1236
1739
  tags?: string[];
1237
- /** Filter on the IP address (Works as a LIKE operation on the IP address). */
1740
+ /**
1741
+ * Filter on the IP address (Works as a LIKE operation on the IP address).
1742
+ */
1238
1743
  name?: string;
1239
1744
  /**
1240
- * A positive integer lower or equal to 100 to select the number of items to
1241
- * return.
1745
+ * A positive integer lower or equal to 100 to select the number of items to return.
1242
1746
  */
1243
1747
  perPage?: number;
1244
- /** A positive integer to choose the page to return. */
1748
+ /**
1749
+ * A positive integer to choose the page to return.
1750
+ */
1245
1751
  page?: number;
1246
1752
  /**
1247
- * Filter on the IP Mobility IP type (whose value should be either
1248
- * 'routed_ipv4' or 'routed_ipv6').
1753
+ * Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
1249
1754
  */
1250
1755
  type?: string;
1251
1756
  };
1252
1757
  export interface ListIpsResponse {
1253
- /** Total number of ips. */
1758
+ /**
1759
+ * Total number of ips.
1760
+ */
1254
1761
  totalCount: number;
1255
- /** List of ips. */
1762
+ /**
1763
+ * List of ips.
1764
+ */
1256
1765
  ips: Ip[];
1257
1766
  }
1258
1767
  export type ListPlacementGroupsRequest = {
1259
- /** Zone to target. If none is passed will use default zone from the config. */
1768
+ /**
1769
+ * Zone to target. If none is passed will use default zone from the config.
1770
+ */
1260
1771
  zone?: ScwZone;
1261
1772
  /**
1262
- * A positive integer lower or equal to 100 to select the number of items to
1263
- * return.
1773
+ * A positive integer lower or equal to 100 to select the number of items to return.
1264
1774
  */
1265
1775
  perPage?: number;
1266
- /** A positive integer to choose the page to return. */
1776
+ /**
1777
+ * A positive integer to choose the page to return.
1778
+ */
1267
1779
  page?: number;
1268
- /** List only placement groups of this Organization ID. */
1780
+ /**
1781
+ * List only placement groups of this Organization ID.
1782
+ */
1269
1783
  organization?: string;
1270
- /** List only placement groups of this Project ID. */
1784
+ /**
1785
+ * List only placement groups of this Project ID.
1786
+ */
1271
1787
  project?: string;
1272
1788
  /**
1273
- * List placement groups with these exact tags (to filter with several tags,
1274
- * use commas to separate them).
1789
+ * List placement groups with these exact tags (to filter with several tags, use commas to separate them).
1275
1790
  */
1276
1791
  tags?: string[];
1277
1792
  /**
1278
- * Filter placement groups by name (for eg. "cluster1" will return
1279
- * "cluster100" and "cluster1" but not "foo").
1793
+ * Filter placement groups by name (for eg. "cluster1" will return "cluster100" and "cluster1" but not "foo").
1280
1794
  */
1281
1795
  name?: string;
1282
1796
  };
1283
1797
  export interface ListPlacementGroupsResponse {
1284
- /** Total number of placement groups. */
1798
+ /**
1799
+ * Total number of placement groups.
1800
+ */
1285
1801
  totalCount: number;
1286
- /** List of placement groups. */
1802
+ /**
1803
+ * List of placement groups.
1804
+ */
1287
1805
  placementGroups: PlacementGroup[];
1288
1806
  }
1289
1807
  export type ListPrivateNICsRequest = {
1290
- /** Zone to target. If none is passed will use default zone from the config. */
1808
+ /**
1809
+ * Zone to target. If none is passed will use default zone from the config.
1810
+ */
1291
1811
  zone?: ScwZone;
1292
- /** Instance to which the private NIC is attached. */
1812
+ /**
1813
+ * Instance to which the private NIC is attached.
1814
+ */
1293
1815
  serverId: string;
1294
- /** Private NIC tags. */
1816
+ /**
1817
+ * Private NIC tags.
1818
+ */
1295
1819
  tags?: string[];
1296
1820
  /**
1297
- * A positive integer lower or equal to 100 to select the number of items to
1298
- * return.
1821
+ * A positive integer lower or equal to 100 to select the number of items to return.
1299
1822
  */
1300
1823
  perPage?: number;
1301
- /** A positive integer to choose the page to return. */
1824
+ /**
1825
+ * A positive integer to choose the page to return.
1826
+ */
1302
1827
  page?: number;
1303
1828
  };
1304
1829
  export interface ListPrivateNICsResponse {
@@ -1306,56 +1831,81 @@ export interface ListPrivateNICsResponse {
1306
1831
  totalCount: number;
1307
1832
  }
1308
1833
  export type ListSecurityGroupRulesRequest = {
1309
- /** Zone to target. If none is passed will use default zone from the config. */
1834
+ /**
1835
+ * Zone to target. If none is passed will use default zone from the config.
1836
+ */
1310
1837
  zone?: ScwZone;
1311
- /** UUID of the security group. */
1838
+ /**
1839
+ * UUID of the security group.
1840
+ */
1312
1841
  securityGroupId: string;
1313
1842
  /**
1314
- * A positive integer lower or equal to 100 to select the number of items to
1315
- * return.
1843
+ * A positive integer lower or equal to 100 to select the number of items to return.
1316
1844
  */
1317
1845
  perPage?: number;
1318
- /** A positive integer to choose the page to return. */
1846
+ /**
1847
+ * A positive integer to choose the page to return.
1848
+ */
1319
1849
  page?: number;
1320
1850
  };
1321
1851
  export interface ListSecurityGroupRulesResponse {
1322
- /** Total number of security groups. */
1852
+ /**
1853
+ * Total number of security groups.
1854
+ */
1323
1855
  totalCount: number;
1324
- /** List of security rules. */
1856
+ /**
1857
+ * List of security rules.
1858
+ */
1325
1859
  rules: SecurityGroupRule[];
1326
1860
  }
1327
1861
  export type ListSecurityGroupsRequest = {
1328
- /** Zone to target. If none is passed will use default zone from the config. */
1862
+ /**
1863
+ * Zone to target. If none is passed will use default zone from the config.
1864
+ */
1329
1865
  zone?: ScwZone;
1330
- /** Name of the security group. */
1866
+ /**
1867
+ * Name of the security group.
1868
+ */
1331
1869
  name?: string;
1332
- /** Security group Organization ID. */
1870
+ /**
1871
+ * Security group Organization ID.
1872
+ */
1333
1873
  organization?: string;
1334
- /** Security group Project ID. */
1874
+ /**
1875
+ * Security group Project ID.
1876
+ */
1335
1877
  project?: string;
1336
1878
  /**
1337
- * List security groups with these exact tags (to filter with several tags,
1338
- * use commas to separate them).
1879
+ * List security groups with these exact tags (to filter with several tags, use commas to separate them).
1339
1880
  */
1340
1881
  tags?: string[];
1341
- /** Filter security groups with this value for project_default. */
1882
+ /**
1883
+ * Filter security groups with this value for project_default.
1884
+ */
1342
1885
  projectDefault?: boolean;
1343
1886
  /**
1344
- * A positive integer lower or equal to 100 to select the number of items to
1345
- * return.
1887
+ * A positive integer lower or equal to 100 to select the number of items to return.
1346
1888
  */
1347
1889
  perPage?: number;
1348
- /** A positive integer to choose the page to return. */
1890
+ /**
1891
+ * A positive integer to choose the page to return.
1892
+ */
1349
1893
  page?: number;
1350
1894
  };
1351
1895
  export interface ListSecurityGroupsResponse {
1352
- /** Total number of security groups. */
1896
+ /**
1897
+ * Total number of security groups.
1898
+ */
1353
1899
  totalCount: number;
1354
- /** List of security groups. */
1900
+ /**
1901
+ * List of security groups.
1902
+ */
1355
1903
  securityGroups: SecurityGroup[];
1356
1904
  }
1357
1905
  export type ListServerActionsRequest = {
1358
- /** Zone to target. If none is passed will use default zone from the config. */
1906
+ /**
1907
+ * Zone to target. If none is passed will use default zone from the config.
1908
+ */
1359
1909
  zone?: ScwZone;
1360
1910
  serverId: string;
1361
1911
  };
@@ -1363,173 +1913,240 @@ export interface ListServerActionsResponse {
1363
1913
  actions: ServerAction[];
1364
1914
  }
1365
1915
  export type ListServerUserDataRequest = {
1366
- /** Zone to target. If none is passed will use default zone from the config. */
1916
+ /**
1917
+ * Zone to target. If none is passed will use default zone from the config.
1918
+ */
1367
1919
  zone?: ScwZone;
1368
- /** UUID of the Instance. */
1920
+ /**
1921
+ * UUID of the Instance.
1922
+ */
1369
1923
  serverId: string;
1370
1924
  };
1371
1925
  export interface ListServerUserDataResponse {
1372
1926
  userData: string[];
1373
1927
  }
1374
1928
  export type ListServersRequest = {
1375
- /** Zone to target. If none is passed will use default zone from the config. */
1929
+ /**
1930
+ * Zone to target. If none is passed will use default zone from the config.
1931
+ */
1376
1932
  zone?: ScwZone;
1377
1933
  /**
1378
- * A positive integer lower or equal to 100 to select the number of items to
1379
- * return.
1934
+ * A positive integer lower or equal to 100 to select the number of items to return.
1380
1935
  */
1381
1936
  perPage?: number;
1382
- /** A positive integer to choose the page to return. */
1937
+ /**
1938
+ * A positive integer to choose the page to return.
1939
+ */
1383
1940
  page?: number;
1384
- /** List only Instances of this Organization ID. */
1941
+ /**
1942
+ * List only Instances of this Organization ID.
1943
+ */
1385
1944
  organization?: string;
1386
- /** List only Instances of this Project ID. */
1945
+ /**
1946
+ * List only Instances of this Project ID.
1947
+ */
1387
1948
  project?: string;
1388
1949
  /**
1389
- * Filter Instances by name (eg. "server1" will return "server100" and
1390
- * "server1" but not "foo").
1950
+ * Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo").
1391
1951
  */
1392
1952
  name?: string;
1393
- /** @deprecated List Instances by private_ip. */
1953
+ /**
1954
+ * @deprecated List Instances by private_ip.
1955
+ */
1394
1956
  privateIp?: string;
1395
- /** List Instances that are not attached to a public IP. */
1957
+ /**
1958
+ * List Instances that are not attached to a public IP.
1959
+ */
1396
1960
  withoutIp?: boolean;
1397
- /** List Instances by IP (both private_ip and public_ip are supported). */
1961
+ /**
1962
+ * List Instances by IP (both private_ip and public_ip are supported).
1963
+ */
1398
1964
  withIp?: string;
1399
- /** List Instances of this commercial type. */
1965
+ /**
1966
+ * List Instances of this commercial type.
1967
+ */
1400
1968
  commercialType?: string;
1401
- /** List Instances in this state. */
1969
+ /**
1970
+ * List Instances in this state.
1971
+ */
1402
1972
  state?: ServerState;
1403
1973
  /**
1404
- * List Instances with these exact tags (to filter with several tags, use
1405
- * commas to separate them).
1974
+ * List Instances with these exact tags (to filter with several tags, use commas to separate them).
1406
1975
  */
1407
1976
  tags?: string[];
1408
- /** List Instances in this Private Network. */
1977
+ /**
1978
+ * List Instances in this Private Network.
1979
+ */
1409
1980
  privateNetwork?: string;
1410
- /** Define the order of the returned servers. */
1981
+ /**
1982
+ * Define the order of the returned servers.
1983
+ */
1411
1984
  order?: ListServersRequestOrder;
1412
1985
  /**
1413
- * List Instances from the given Private Networks (use commas to separate
1414
- * them).
1986
+ * List Instances from the given Private Networks (use commas to separate them).
1415
1987
  */
1416
1988
  privateNetworks?: string[];
1417
- /** List Instances associated with the given private NIC MAC address. */
1989
+ /**
1990
+ * List Instances associated with the given private NIC MAC address.
1991
+ */
1418
1992
  privateNicMacAddress?: string;
1419
- /** List Instances from these server ids (use commas to separate them). */
1993
+ /**
1994
+ * List Instances from these server ids (use commas to separate them).
1995
+ */
1420
1996
  servers?: string[];
1421
1997
  };
1422
1998
  export interface ListServersResponse {
1423
- /** Total number of Instances. */
1999
+ /**
2000
+ * Total number of Instances.
2001
+ */
1424
2002
  totalCount: number;
1425
- /** List of Instances. */
2003
+ /**
2004
+ * List of Instances.
2005
+ */
1426
2006
  servers: Server[];
1427
2007
  }
1428
2008
  export type ListServersTypesRequest = {
1429
- /** Zone to target. If none is passed will use default zone from the config. */
2009
+ /**
2010
+ * Zone to target. If none is passed will use default zone from the config.
2011
+ */
1430
2012
  zone?: ScwZone;
1431
2013
  perPage?: number;
1432
2014
  page?: number;
1433
2015
  };
1434
2016
  export interface ListServersTypesResponse {
1435
- /** Total number of Instance types. */
2017
+ /**
2018
+ * Total number of Instance types.
2019
+ */
1436
2020
  totalCount: number;
1437
- /** List of Instance types. */
2021
+ /**
2022
+ * List of Instance types.
2023
+ */
1438
2024
  servers: Record<string, ServerType>;
1439
2025
  }
1440
2026
  export type ListSnapshotsRequest = {
1441
- /** Zone to target. If none is passed will use default zone from the config. */
2027
+ /**
2028
+ * Zone to target. If none is passed will use default zone from the config.
2029
+ */
1442
2030
  zone?: ScwZone;
1443
- /** List snapshots only for this Organization ID. */
2031
+ /**
2032
+ * List snapshots only for this Organization ID.
2033
+ */
1444
2034
  organization?: string;
1445
- /** List snapshots only for this Project ID. */
2035
+ /**
2036
+ * List snapshots only for this Project ID.
2037
+ */
1446
2038
  project?: string;
1447
2039
  /**
1448
- * Number of snapshots returned per page (positive integer lower or equal to
1449
- * 100).
2040
+ * Number of snapshots returned per page (positive integer lower or equal to 100).
1450
2041
  */
1451
2042
  perPage?: number;
1452
- /** Page to be returned. */
2043
+ /**
2044
+ * Page to be returned.
2045
+ */
1453
2046
  page?: number;
1454
- /** List snapshots of the requested name. */
2047
+ /**
2048
+ * List snapshots of the requested name.
2049
+ */
1455
2050
  name?: string;
1456
- /** List snapshots that have the requested tag. */
2051
+ /**
2052
+ * List snapshots that have the requested tag.
2053
+ */
1457
2054
  tags?: string;
1458
- /** List snapshots originating only from this volume. */
2055
+ /**
2056
+ * List snapshots originating only from this volume.
2057
+ */
1459
2058
  baseVolumeId?: string;
1460
2059
  };
1461
2060
  export interface ListSnapshotsResponse {
1462
- /** Total number of snapshots. */
2061
+ /**
2062
+ * Total number of snapshots.
2063
+ */
1463
2064
  totalCount: number;
1464
- /** List of snapshots. */
2065
+ /**
2066
+ * List of snapshots.
2067
+ */
1465
2068
  snapshots: Snapshot[];
1466
2069
  }
1467
2070
  export type ListVolumesRequest = {
1468
- /** Zone to target. If none is passed will use default zone from the config. */
2071
+ /**
2072
+ * Zone to target. If none is passed will use default zone from the config.
2073
+ */
1469
2074
  zone?: ScwZone;
1470
- /** Filter by volume type. */
2075
+ /**
2076
+ * Filter by volume type.
2077
+ */
1471
2078
  volumeType?: VolumeVolumeType;
1472
2079
  /**
1473
- * A positive integer lower or equal to 100 to select the number of items to
1474
- * return.
2080
+ * A positive integer lower or equal to 100 to select the number of items to return.
1475
2081
  */
1476
2082
  perPage?: number;
1477
- /** A positive integer to choose the page to return. */
2083
+ /**
2084
+ * A positive integer to choose the page to return.
2085
+ */
1478
2086
  page?: number;
1479
- /** Filter volume by Organization ID. */
2087
+ /**
2088
+ * Filter volume by Organization ID.
2089
+ */
1480
2090
  organization?: string;
1481
- /** Filter volume by Project ID. */
2091
+ /**
2092
+ * Filter volume by Project ID.
2093
+ */
1482
2094
  project?: string;
1483
2095
  /**
1484
- * Filter volumes with these exact tags (to filter with several tags, use
1485
- * commas to separate them).
2096
+ * Filter volumes with these exact tags (to filter with several tags, use commas to separate them).
1486
2097
  */
1487
2098
  tags?: string[];
1488
2099
  /**
1489
- * Filter volume by name (for eg. "vol" will return "myvolume" but not
1490
- * "data").
2100
+ * Filter volume by name (for eg. "vol" will return "myvolume" but not "data").
1491
2101
  */
1492
2102
  name?: string;
1493
2103
  };
1494
2104
  export interface ListVolumesResponse {
1495
- /** Total number of volumes. */
2105
+ /**
2106
+ * Total number of volumes.
2107
+ */
1496
2108
  totalCount: number;
1497
- /** List of volumes. */
2109
+ /**
2110
+ * List of volumes.
2111
+ */
1498
2112
  volumes: Volume[];
1499
2113
  }
1500
2114
  export type ListVolumesTypesRequest = {
1501
- /** Zone to target. If none is passed will use default zone from the config. */
2115
+ /**
2116
+ * Zone to target. If none is passed will use default zone from the config.
2117
+ */
1502
2118
  zone?: ScwZone;
1503
2119
  perPage?: number;
1504
2120
  page?: number;
1505
2121
  };
1506
2122
  export interface ListVolumesTypesResponse {
1507
- /** Total number of volume types. */
2123
+ /**
2124
+ * Total number of volume types.
2125
+ */
1508
2126
  totalCount: number;
1509
- /** Map of volume types. */
2127
+ /**
2128
+ * Map of volume types.
2129
+ */
1510
2130
  volumes: Record<string, VolumeType>;
1511
2131
  }
1512
2132
  export interface MigrationPlan {
1513
2133
  /**
1514
- * A volume which will be migrated to SBS together with the snapshots, if
1515
- * present.
2134
+ * A volume which will be migrated to SBS together with the snapshots, if present.
1516
2135
  */
1517
2136
  volume?: Volume;
1518
2137
  /**
1519
- * A list of snapshots which will be migrated to SBS together and with the
1520
- * volume, if present.
2138
+ * A list of snapshots which will be migrated to SBS together and with the volume, if present.
1521
2139
  */
1522
2140
  snapshots: Snapshot[];
1523
2141
  /**
1524
- * A value to be passed to the call to the [Migrate a volume and/or snapshots
1525
- * to
1526
- * SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage)
1527
- * endpoint, to confirm that the execution of the plan is being requested.
2142
+ * A value to be passed to the call to the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint, to confirm that the execution of the plan is being requested.
1528
2143
  */
1529
2144
  validationKey: string;
1530
2145
  }
1531
2146
  export type PlanBlockMigrationRequest = {
1532
- /** Zone to target. If none is passed will use default zone from the config. */
2147
+ /**
2148
+ * Zone to target. If none is passed will use default zone from the config.
2149
+ */
1533
2150
  zone?: ScwZone;
1534
2151
  /**
1535
2152
  * The volume for which the migration plan will be generated.
@@ -1545,25 +2162,31 @@ export type PlanBlockMigrationRequest = {
1545
2162
  snapshotId?: string;
1546
2163
  };
1547
2164
  export type ServerActionRequest = {
1548
- /** Zone to target. If none is passed will use default zone from the config. */
2165
+ /**
2166
+ * Zone to target. If none is passed will use default zone from the config.
2167
+ */
1549
2168
  zone?: ScwZone;
1550
- /** UUID of the Instance. */
2169
+ /**
2170
+ * UUID of the Instance.
2171
+ */
1551
2172
  serverId: string;
1552
- /** Action to perform on the Instance. */
2173
+ /**
2174
+ * Action to perform on the Instance.
2175
+ */
1553
2176
  action?: ServerAction;
1554
2177
  /**
1555
- * Name of the backup you want to create. This field should only be specified
1556
- * when performing a backup action.
2178
+ * Name of the backup you want to create.
2179
+ This field should only be specified when performing a backup action.
1557
2180
  */
1558
2181
  name?: string;
1559
2182
  /**
1560
- * For each volume UUID, the snapshot parameters of the volume. This field
1561
- * should only be specified when performing a backup action.
2183
+ * For each volume UUID, the snapshot parameters of the volume.
2184
+ This field should only be specified when performing a backup action.
1562
2185
  */
1563
2186
  volumes?: Record<string, ServerActionRequestVolumeBackupTemplate>;
1564
2187
  /**
1565
- * Disable IPv6 on the Instance while performing migration to routed IPs. This
1566
- * field should only be specified when performing a enable_routed_ip action.
2188
+ * Disable IPv6 on the Instance while performing migration to routed IPs.
2189
+ This field should only be specified when performing a enable_routed_ip action.
1567
2190
  */
1568
2191
  disableIpv6?: boolean;
1569
2192
  };
@@ -1571,18 +2194,24 @@ export interface ServerActionResponse {
1571
2194
  task?: Task;
1572
2195
  }
1573
2196
  export interface ServerCompatibleTypes {
1574
- /** Instance compatible types. */
2197
+ /**
2198
+ * Instance compatible types.
2199
+ */
1575
2200
  compatibleTypes: string[];
1576
2201
  }
1577
2202
  export type SetImageRequest = {
1578
- /** Zone to target. If none is passed will use default zone from the config. */
2203
+ /**
2204
+ * Zone to target. If none is passed will use default zone from the config.
2205
+ */
1579
2206
  zone?: ScwZone;
1580
2207
  id: string;
1581
2208
  name: string;
1582
2209
  arch?: Arch;
1583
2210
  creationDate?: Date;
1584
2211
  modificationDate?: Date;
1585
- /** @deprecated */
2212
+ /**
2213
+ * @deprecated
2214
+ */
1586
2215
  defaultBootscript?: Bootscript;
1587
2216
  extraVolumes?: Record<string, Volume>;
1588
2217
  fromServer: string;
@@ -1594,7 +2223,9 @@ export type SetImageRequest = {
1594
2223
  tags?: string[];
1595
2224
  };
1596
2225
  export type SetPlacementGroupRequest = {
1597
- /** Zone to target. If none is passed will use default zone from the config. */
2226
+ /**
2227
+ * Zone to target. If none is passed will use default zone from the config.
2228
+ */
1598
2229
  zone?: ScwZone;
1599
2230
  placementGroupId: string;
1600
2231
  name: string;
@@ -1608,60 +2239,95 @@ export interface SetPlacementGroupResponse {
1608
2239
  placementGroup?: PlacementGroup;
1609
2240
  }
1610
2241
  export type SetPlacementGroupServersRequest = {
1611
- /** Zone to target. If none is passed will use default zone from the config. */
2242
+ /**
2243
+ * Zone to target. If none is passed will use default zone from the config.
2244
+ */
1612
2245
  zone?: ScwZone;
1613
- /** UUID of the placement group you want to set. */
2246
+ /**
2247
+ * UUID of the placement group you want to set.
2248
+ */
1614
2249
  placementGroupId: string;
1615
- /** An array of the Instances' UUIDs you want to configure. */
2250
+ /**
2251
+ * An array of the Instances' UUIDs you want to configure.
2252
+ */
1616
2253
  servers: string[];
1617
2254
  };
1618
2255
  export interface SetPlacementGroupServersResponse {
1619
- /** Instances attached to the placement group. */
2256
+ /**
2257
+ * Instances attached to the placement group.
2258
+ */
1620
2259
  servers: PlacementGroupServer[];
1621
2260
  }
1622
2261
  export type SetSecurityGroupRulesRequest = {
1623
- /** Zone to target. If none is passed will use default zone from the config. */
2262
+ /**
2263
+ * Zone to target. If none is passed will use default zone from the config.
2264
+ */
1624
2265
  zone?: ScwZone;
1625
- /** UUID of the security group to update the rules on. */
2266
+ /**
2267
+ * UUID of the security group to update the rules on.
2268
+ */
1626
2269
  securityGroupId: string;
1627
- /** List of rules to update in the security group. */
2270
+ /**
2271
+ * List of rules to update in the security group.
2272
+ */
1628
2273
  rules?: SetSecurityGroupRulesRequestRule[];
1629
2274
  };
1630
2275
  export interface SetSecurityGroupRulesResponse {
1631
2276
  rules: SecurityGroupRule[];
1632
2277
  }
1633
2278
  export type UpdateImageRequest = {
1634
- /** Zone to target. If none is passed will use default zone from the config. */
2279
+ /**
2280
+ * Zone to target. If none is passed will use default zone from the config.
2281
+ */
1635
2282
  zone?: ScwZone;
1636
- /** UUID of the image. */
2283
+ /**
2284
+ * UUID of the image.
2285
+ */
1637
2286
  imageId: string;
1638
- /** Name of the image. */
2287
+ /**
2288
+ * Name of the image.
2289
+ */
1639
2290
  name?: string;
1640
- /** Architecture of the image. */
2291
+ /**
2292
+ * Architecture of the image.
2293
+ */
1641
2294
  arch?: Arch;
1642
2295
  /**
1643
- * Additional snapshots of the image, with extra_volumeKey being the position
1644
- * of the snapshot in the image.
2296
+ * Additional snapshots of the image, with extra_volumeKey being the position of the snapshot in the image.
1645
2297
  */
1646
2298
  extraVolumes?: Record<string, VolumeImageUpdateTemplate>;
1647
- /** Tags of the image. */
2299
+ /**
2300
+ * Tags of the image.
2301
+ */
1648
2302
  tags?: string[];
1649
- /** True to set the image as public. */
2303
+ /**
2304
+ * True to set the image as public.
2305
+ */
1650
2306
  public?: boolean;
1651
2307
  };
1652
2308
  export interface UpdateImageResponse {
1653
2309
  image?: Image;
1654
2310
  }
1655
2311
  export type UpdateIpRequest = {
1656
- /** Zone to target. If none is passed will use default zone from the config. */
2312
+ /**
2313
+ * Zone to target. If none is passed will use default zone from the config.
2314
+ */
1657
2315
  zone?: ScwZone;
1658
- /** IP ID or IP address. */
2316
+ /**
2317
+ * IP ID or IP address.
2318
+ */
1659
2319
  ip: string;
1660
- /** Reverse domain name. */
2320
+ /**
2321
+ * Reverse domain name.
2322
+ */
1661
2323
  reverse?: string | null;
1662
- /** Should have no effect. */
2324
+ /**
2325
+ * Should have no effect.
2326
+ */
1663
2327
  type?: IpType;
1664
- /** An array of keywords you want to tag this IP with. */
2328
+ /**
2329
+ * An array of keywords you want to tag this IP with.
2330
+ */
1665
2331
  tags?: string[];
1666
2332
  server?: string | null;
1667
2333
  };
@@ -1669,149 +2335,218 @@ export interface UpdateIpResponse {
1669
2335
  ip?: Ip;
1670
2336
  }
1671
2337
  export type UpdatePlacementGroupRequest = {
1672
- /** Zone to target. If none is passed will use default zone from the config. */
2338
+ /**
2339
+ * Zone to target. If none is passed will use default zone from the config.
2340
+ */
1673
2341
  zone?: ScwZone;
1674
- /** UUID of the placement group. */
2342
+ /**
2343
+ * UUID of the placement group.
2344
+ */
1675
2345
  placementGroupId: string;
1676
- /** Name of the placement group. */
2346
+ /**
2347
+ * Name of the placement group.
2348
+ */
1677
2349
  name?: string;
1678
- /** Tags of the placement group. */
2350
+ /**
2351
+ * Tags of the placement group.
2352
+ */
1679
2353
  tags?: string[];
1680
- /** Operating mode of the placement group. */
2354
+ /**
2355
+ * Operating mode of the placement group.
2356
+ */
1681
2357
  policyMode?: PlacementGroupPolicyMode;
1682
- /** Policy type of the placement group. */
2358
+ /**
2359
+ * Policy type of the placement group.
2360
+ */
1683
2361
  policyType?: PlacementGroupPolicyType;
1684
2362
  };
1685
2363
  export interface UpdatePlacementGroupResponse {
1686
2364
  placementGroup?: PlacementGroup;
1687
2365
  }
1688
2366
  export type UpdatePlacementGroupServersRequest = {
1689
- /** Zone to target. If none is passed will use default zone from the config. */
2367
+ /**
2368
+ * Zone to target. If none is passed will use default zone from the config.
2369
+ */
1690
2370
  zone?: ScwZone;
1691
- /** UUID of the placement group you want to update. */
2371
+ /**
2372
+ * UUID of the placement group you want to update.
2373
+ */
1692
2374
  placementGroupId: string;
1693
- /** An array of the Instances' UUIDs you want to configure. */
2375
+ /**
2376
+ * An array of the Instances' UUIDs you want to configure.
2377
+ */
1694
2378
  servers: string[];
1695
2379
  };
1696
2380
  export interface UpdatePlacementGroupServersResponse {
1697
- /** Instances attached to the placement group. */
2381
+ /**
2382
+ * Instances attached to the placement group.
2383
+ */
1698
2384
  servers: PlacementGroupServer[];
1699
2385
  }
1700
2386
  export type UpdatePrivateNICRequest = {
1701
- /** Zone to target. If none is passed will use default zone from the config. */
2387
+ /**
2388
+ * Zone to target. If none is passed will use default zone from the config.
2389
+ */
1702
2390
  zone?: ScwZone;
1703
- /** UUID of the Instance the private NIC will be attached to. */
2391
+ /**
2392
+ * UUID of the Instance the private NIC will be attached to.
2393
+ */
1704
2394
  serverId: string;
1705
- /** Private NIC unique ID. */
2395
+ /**
2396
+ * Private NIC unique ID.
2397
+ */
1706
2398
  privateNicId: string;
1707
- /** Tags used to select private NIC/s. */
2399
+ /**
2400
+ * Tags used to select private NIC/s.
2401
+ */
1708
2402
  tags?: string[];
1709
2403
  };
1710
2404
  export type UpdateSecurityGroupRequest = {
1711
- /** Zone to target. If none is passed will use default zone from the config. */
2405
+ /**
2406
+ * Zone to target. If none is passed will use default zone from the config.
2407
+ */
1712
2408
  zone?: ScwZone;
1713
- /** UUID of the security group. */
2409
+ /**
2410
+ * UUID of the security group.
2411
+ */
1714
2412
  securityGroupId: string;
1715
- /** Name of the security group. */
2413
+ /**
2414
+ * Name of the security group.
2415
+ */
1716
2416
  name?: string;
1717
- /** Description of the security group. */
2417
+ /**
2418
+ * Description of the security group.
2419
+ */
1718
2420
  description?: string;
1719
2421
  /**
1720
- * True to block SMTP on IPv4 and IPv6. This feature is read only, please open
1721
- * a support ticket if you need to make it configurable.
2422
+ * True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
1722
2423
  */
1723
2424
  enableDefaultSecurity?: boolean;
1724
- /** Default inbound policy. */
2425
+ /**
2426
+ * Default inbound policy.
2427
+ */
1725
2428
  inboundDefaultPolicy?: SecurityGroupPolicy;
1726
- /** Tags of the security group. */
2429
+ /**
2430
+ * Tags of the security group.
2431
+ */
1727
2432
  tags?: string[];
1728
- /** @deprecated Please use project_default instead. */
2433
+ /**
2434
+ * @deprecated Please use project_default instead.
2435
+ */
1729
2436
  organizationDefault?: boolean;
1730
- /** True use this security group for future Instances created in this project. */
2437
+ /**
2438
+ * True use this security group for future Instances created in this project.
2439
+ */
1731
2440
  projectDefault?: boolean;
1732
- /** Default outbound policy. */
2441
+ /**
2442
+ * Default outbound policy.
2443
+ */
1733
2444
  outboundDefaultPolicy?: SecurityGroupPolicy;
1734
- /** True to set the security group as stateful. */
2445
+ /**
2446
+ * True to set the security group as stateful.
2447
+ */
1735
2448
  stateful?: boolean;
1736
2449
  };
1737
2450
  export interface UpdateSecurityGroupResponse {
1738
2451
  securityGroup?: SecurityGroup;
1739
2452
  }
1740
2453
  export type UpdateSecurityGroupRuleRequest = {
1741
- /** Zone to target. If none is passed will use default zone from the config. */
2454
+ /**
2455
+ * Zone to target. If none is passed will use default zone from the config.
2456
+ */
1742
2457
  zone?: ScwZone;
1743
- /** UUID of the security group. */
2458
+ /**
2459
+ * UUID of the security group.
2460
+ */
1744
2461
  securityGroupId: string;
1745
- /** UUID of the rule. */
2462
+ /**
2463
+ * UUID of the rule.
2464
+ */
1746
2465
  securityGroupRuleId: string;
1747
- /** Protocol family this rule applies to. */
2466
+ /**
2467
+ * Protocol family this rule applies to.
2468
+ */
1748
2469
  protocol?: SecurityGroupRuleProtocol;
1749
- /** Direction the rule applies to. */
2470
+ /**
2471
+ * Direction the rule applies to.
2472
+ */
1750
2473
  direction?: SecurityGroupRuleDirection;
1751
- /** Action to apply when the rule matches a packet. */
2474
+ /**
2475
+ * Action to apply when the rule matches a packet.
2476
+ */
1752
2477
  action?: SecurityGroupRuleAction;
1753
- /** Range of IP addresses these rules apply to. */
2478
+ /**
2479
+ * Range of IP addresses these rules apply to.
2480
+ */
1754
2481
  ipRange?: string;
1755
2482
  /**
1756
- * Beginning of the range of ports this rule applies to (inclusive). If 0 is
1757
- * provided, unset the parameter.
2483
+ * Beginning of the range of ports this rule applies to (inclusive). If 0 is provided, unset the parameter.
1758
2484
  */
1759
2485
  destPortFrom?: number;
1760
2486
  /**
1761
- * End of the range of ports this rule applies to (inclusive). If 0 is
1762
- * provided, unset the parameter.
2487
+ * End of the range of ports this rule applies to (inclusive). If 0 is provided, unset the parameter.
1763
2488
  */
1764
2489
  destPortTo?: number;
1765
- /** Position of this rule in the security group rules list. */
2490
+ /**
2491
+ * Position of this rule in the security group rules list.
2492
+ */
1766
2493
  position?: number;
1767
2494
  };
1768
2495
  export interface UpdateSecurityGroupRuleResponse {
1769
2496
  rule?: SecurityGroupRule;
1770
2497
  }
1771
2498
  export type UpdateServerRequest = {
1772
- /** Zone to target. If none is passed will use default zone from the config. */
2499
+ /**
2500
+ * Zone to target. If none is passed will use default zone from the config.
2501
+ */
1773
2502
  zone?: ScwZone;
1774
- /** UUID of the Instance. */
2503
+ /**
2504
+ * UUID of the Instance.
2505
+ */
1775
2506
  serverId: string;
1776
- /** Name of the Instance. */
2507
+ /**
2508
+ * Name of the Instance.
2509
+ */
1777
2510
  name?: string;
1778
2511
  bootType?: BootType;
1779
- /** Tags of the Instance. */
2512
+ /**
2513
+ * Tags of the Instance.
2514
+ */
1780
2515
  tags?: string[];
1781
2516
  volumes?: Record<string, VolumeServerTemplate>;
1782
2517
  dynamicIpRequired?: boolean;
1783
2518
  /**
1784
- * @deprecated True to configure the instance so it uses the new routed IP
1785
- * mode (once this is set to True you cannot set it back to False).
2519
+ * @deprecated True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False).
1786
2520
  */
1787
2521
  routedIpEnabled?: boolean;
1788
- /** A list of reserved IP IDs to attach to the Instance. */
2522
+ /**
2523
+ * A list of reserved IP IDs to attach to the Instance.
2524
+ */
1789
2525
  publicIps?: string[];
1790
- /** @deprecated */
2526
+ /**
2527
+ * @deprecated
2528
+ */
1791
2529
  enableIpv6?: boolean;
1792
2530
  protected?: boolean;
1793
2531
  securityGroup?: SecurityGroupTemplate;
1794
- /** Placement group ID if Instance must be part of a placement group. */
2532
+ /**
2533
+ * Placement group ID if Instance must be part of a placement group.
2534
+ */
1795
2535
  placementGroup?: string | null;
1796
- /** Instance private NICs. */
2536
+ /**
2537
+ * Instance private NICs.
2538
+ */
1797
2539
  privateNics?: string[];
1798
2540
  /**
1799
2541
  * Warning: This field has some restrictions:
1800
- *
1801
- * - Cannot be changed if the Instance is not in `stopped` state.
1802
- * - Cannot be changed if the Instance is in a placement group.
1803
- * - Cannot be changed from/to a Windows offer to/from a Linux offer.
1804
- * - Local storage requirements of the target commercial_types must be fulfilled
1805
- * (i.e. if an Instance has 80GB of local storage, it can be changed into a
1806
- * GP1-XS, which has a maximum of 150GB, but it cannot be changed into a
1807
- * DEV1-S, which has only 20GB).
2542
+ - Cannot be changed if the Instance is not in `stopped` state.
2543
+ - Cannot be changed if the Instance is in a placement group.
2544
+ - Cannot be changed from/to a Windows offer to/from a Linux offer.
2545
+ - Local storage requirements of the target commercial_types must be fulfilled (i.e. if an Instance has 80GB of local storage, it can be changed into a GP1-XS, which has a maximum of 150GB, but it cannot be changed into a DEV1-S, which has only 20GB).
1808
2546
  */
1809
2547
  commercialType?: string;
1810
2548
  /**
1811
- * The public_key value of this key is used to encrypt the admin password.
1812
- * When set to an empty string, reset this value and
1813
- * admin_password_encrypted_value to an empty string so a new password may be
1814
- * generated.
2549
+ * The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated.
1815
2550
  */
1816
2551
  adminPasswordEncryptionSshKeyId?: string;
1817
2552
  };
@@ -1819,28 +2554,46 @@ export interface UpdateServerResponse {
1819
2554
  server?: Server;
1820
2555
  }
1821
2556
  export type UpdateSnapshotRequest = {
1822
- /** Zone to target. If none is passed will use default zone from the config. */
2557
+ /**
2558
+ * Zone to target. If none is passed will use default zone from the config.
2559
+ */
1823
2560
  zone?: ScwZone;
1824
- /** UUID of the snapshot. */
2561
+ /**
2562
+ * UUID of the snapshot.
2563
+ */
1825
2564
  snapshotId: string;
1826
- /** Name of the snapshot. */
2565
+ /**
2566
+ * Name of the snapshot.
2567
+ */
1827
2568
  name?: string;
1828
- /** Tags of the snapshot. */
2569
+ /**
2570
+ * Tags of the snapshot.
2571
+ */
1829
2572
  tags?: string[];
1830
2573
  };
1831
2574
  export interface UpdateSnapshotResponse {
1832
2575
  snapshot?: Snapshot;
1833
2576
  }
1834
2577
  export type UpdateVolumeRequest = {
1835
- /** Zone to target. If none is passed will use default zone from the config. */
2578
+ /**
2579
+ * Zone to target. If none is passed will use default zone from the config.
2580
+ */
1836
2581
  zone?: ScwZone;
1837
- /** UUID of the volume. */
2582
+ /**
2583
+ * UUID of the volume.
2584
+ */
1838
2585
  volumeId: string;
1839
- /** Volume name. */
2586
+ /**
2587
+ * Volume name.
2588
+ */
1840
2589
  name?: string;
1841
- /** Tags of the volume. */
2590
+ /**
2591
+ * Tags of the volume.
2592
+ */
1842
2593
  tags?: string[];
1843
- /** Volume disk size, must be a multiple of 512. */
2594
+ /**
2595
+ * Volume disk size, must be a multiple of 512.
2596
+ */
1844
2597
  size?: number;
1845
2598
  };
1846
2599
  export interface UpdateVolumeResponse {