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