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
|
# ImagesApi
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**images_delete**](ImagesApi.md#images_delete) | **DELETE** /images/{imageId} | Delete images |
| [**images_find_by_id**](ImagesApi.md#images_find_by_id) | **GET** /images/{imageId} | Retrieve images |
| [**images_get**](ImagesApi.md#images_get) | **GET** /images | List images |
| [**images_patch**](ImagesApi.md#images_patch) | **PATCH** /images/{imageId} | Partially modify images |
| [**images_put**](ImagesApi.md#images_put) | **PUT** /images/{imageId} | Modify an Image by ID |
# **images_delete**
> images_delete(image_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete images
Delete the specified image; this operation is only supported for private images.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.ImagesApi(api_client)
image_id = 'image_id_example' # str | The unique ID of the image.
try:
# Delete images
api_instance.images_delete(image_id)
except ApiException as e:
print('Exception when calling ImagesApi.images_delete: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **image_id** | **str**| The unique ID of the image. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional] [default to 0] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
void (empty response body)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **images_find_by_id**
> Image images_find_by_id(image_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve images
Retrieve the properties of the specified image.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.ImagesApi(api_client)
image_id = 'image_id_example' # str | The unique ID of the image.
try:
# Retrieve images
api_response = api_instance.images_find_by_id(image_id)
print(api_response)
except ApiException as e:
print('Exception when calling ImagesApi.images_find_by_id: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **image_id** | **str**| The unique ID of the image. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional] [default to 0] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Image**](../models/Image.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **images_get**
> Images images_get(pretty=pretty, depth=depth, x_contract_number=x_contract_number)
List images
List all the images within the data center.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.ImagesApi(api_client)
try:
# List images
api_response = api_instance.images_get()
print(api_response)
except ApiException as e:
print('Exception when calling ImagesApi.images_get: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional] [default to 0] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Images**](../models/Images.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **images_patch**
> Image images_patch(image_id, image, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Partially modify images
Update the properties of the specified image.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.ImagesApi(api_client)
image_id = 'image_id_example' # str | The unique ID of the image.
image = ionoscloud.ImageProperties() # ImageProperties | The image properties to be updated.
try:
# Partially modify images
api_response = api_instance.images_patch(image_id, image)
print(api_response)
except ApiException as e:
print('Exception when calling ImagesApi.images_patch: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **image_id** | **str**| The unique ID of the image. | |
| **image** | [**ImageProperties**](../models/ImageProperties.md)| The image properties to be updated. | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional] [default to 0] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Image**](../models/Image.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
# **images_put**
> Image images_put(image_id, image, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Modify an Image by ID
Modifies the properties of the specified image.
### Example
```python
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.ImagesApi(api_client)
image_id = 'image_id_example' # str | The unique ID of the image.
image = ionoscloud.Image() # Image | The modified image
try:
# Modify an Image by ID
api_response = api_instance.images_put(image_id, image)
print(api_response)
except ApiException as e:
print('Exception when calling ImagesApi.images_put: %s\n' % e)
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **image_id** | **str**| The unique ID of the image. | |
| **image** | [**Image**](../models/Image.md)| The modified image | |
| **pretty** | **bool**| Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
| **depth** | **int**| Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional] [default to 0] |
| **x_contract_number** | **int**| Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
[**Image**](../models/Image.md)
### Authorization
Basic Authentication, Token Authentication
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
|
