scaleway_api_rs 0.1.8

Generated library to interact with Scaleway API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307

# \ImagesApi

All URIs are relative to *https://api.scaleway.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_image**](ImagesApi.md#create_image) | **POST** /instance/v1/zones/{zone}/images | Create an instance image
[**delete_image**](ImagesApi.md#delete_image) | **DELETE** /instance/v1/zones/{zone}/images/{image_id} | Delete an instance image
[**delete_image1**](ImagesApi.md#delete_image1) | **DELETE** /registry/v1/regions/{region}/images/{image_id} | Delete an image
[**get_image**](ImagesApi.md#get_image) | **GET** /instance/v1/zones/{zone}/images/{image_id} | Get an instance image
[**get_image1**](ImagesApi.md#get_image1) | **GET** /registry/v1/regions/{region}/images/{image_id} | Get a image
[**list_images**](ImagesApi.md#list_images) | **GET** /instance/v1/zones/{zone}/images | List instance images
[**list_images1**](ImagesApi.md#list_images1) | **GET** /registry/v1/regions/{region}/images | List all your images
[**set_image**](ImagesApi.md#set_image) | **PUT** /instance/v1/zones/{zone}/images/{id} | Update image
[**update_image**](ImagesApi.md#update_image) | **PATCH** /registry/v1/regions/{region}/images/{image_id} | Update an existing image



## create_image

> crate::models::ScalewayPeriodInstancePeriodV1PeriodCreateImageResponse create_image(zone, create_image_request)
Create an instance image

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**create_image_request** | [**CreateImageRequest**](CreateImageRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodCreateImageResponse**](scaleway.instance.v1.CreateImageResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_image

> delete_image(zone, image_id)
Delete an instance image

Delete the image with the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**image_id** | **String** | UUID of the image you want to delete | [required] |

### Return type

 (empty response body)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_image1

> crate::models::ScalewayPeriodRegistryPeriodV1PeriodImage delete_image1(region, image_id)
Delete an image

Delete the image associated with the given id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**image_id** | **String** | The unique ID of the Image | [required] |

### Return type

[**crate::models::ScalewayPeriodRegistryPeriodV1PeriodImage**](scaleway.registry.v1.Image.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_image

> crate::models::ScalewayPeriodInstancePeriodV1PeriodGetImageResponse get_image(zone, image_id)
Get an instance image

Get details of an image with the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**image_id** | **String** | UUID of the image you want to get | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodGetImageResponse**](scaleway.instance.v1.GetImageResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_image1

> crate::models::ScalewayPeriodRegistryPeriodV1PeriodImage get_image1(region, image_id)
Get a image

Get the image associated with the given id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**image_id** | **String** | The unique ID of the Image | [required] |

### Return type

[**crate::models::ScalewayPeriodRegistryPeriodV1PeriodImage**](scaleway.registry.v1.Image.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_images

> crate::models::ScalewayPeriodInstancePeriodV1PeriodListImagesResponse list_images(zone, organization, per_page, page, name, public, arch, project, tags)
List instance images

List all images available in an account.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**organization** | Option<**String**> |  |  |
**per_page** | Option<**i32**> |  |  |
**page** | Option<**i32**> | Page number |  |[default to 1]
**name** | Option<**String**> |  |  |
**public** | Option<**bool**> |  |  |
**arch** | Option<**String**> |  |  |
**project** | Option<**String**> |  |  |
**tags** | Option<**String**> |  |  |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodListImagesResponse**](scaleway.instance.v1.ListImagesResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_images1

> crate::models::ScalewayPeriodRegistryPeriodV1PeriodListImagesResponse list_images1(region, page, page_size, order_by, namespace_id, name, organization_id, project_id)
List all your images

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**page** | Option<**i32**> | A positive integer to choose the page to display |  |[default to 1]
**page_size** | Option<**i32**> | A positive integer lower or equal to 100 to select the number of items to display |  |[default to 20]
**order_by** | Option<**String**> | Field by which to order the display of Images |  |[default to created_at_asc]
**namespace_id** | Option<**String**> | Filter by the Namespace ID |  |
**name** | Option<**String**> | Filter by the Image name (exact match) |  |
**organization_id** | Option<**String**> | Filter by Organization ID |  |
**project_id** | Option<**String**> | Filter by Project ID |  |

### Return type

[**crate::models::ScalewayPeriodRegistryPeriodV1PeriodListImagesResponse**](scaleway.registry.v1.ListImagesResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_image

> crate::models::ScalewayPeriodInstancePeriodV1PeriodSetImageResponse set_image(zone, id, set_image_request)
Update image

Replace all image properties with an image message.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**id** | **String** |  | [required] |
**set_image_request** | [**SetImageRequest**](SetImageRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodSetImageResponse**](scaleway.instance.v1.SetImageResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_image

> crate::models::ScalewayPeriodRegistryPeriodV1PeriodImage update_image(region, image_id, update_image_request)
Update an existing image

Update the image associated with the given id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**image_id** | **String** | Image ID to update | [required] |
**update_image_request** | [**UpdateImageRequest**](UpdateImageRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodRegistryPeriodV1PeriodImage**](scaleway.registry.v1.Image.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)