ionoscloud 5.0.0 → 5.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/AttachedVolumes.md +30 -0
- data/docs/BackupUnit.md +26 -0
- data/docs/BackupUnitApi.md +595 -0
- data/docs/BackupUnitProperties.md +22 -0
- data/docs/BackupUnitSSO.md +18 -0
- data/docs/BackupUnits.md +24 -0
- data/docs/BalancedNics.md +30 -0
- data/docs/CHANGELOG.md +1 -0
- data/docs/Cdroms.md +30 -0
- data/docs/ConnectableDatacenter.md +22 -0
- data/docs/Contract.md +20 -0
- data/docs/ContractApi.md +89 -0
- data/docs/ContractProperties.md +26 -0
- data/docs/DataCenterApi.md +517 -0
- data/docs/DataCenterEntities.md +24 -0
- data/docs/Datacenter.md +28 -0
- data/docs/DatacenterElementMetadata.md +32 -0
- data/docs/DatacenterProperties.md +28 -0
- data/docs/Datacenters.md +30 -0
- data/docs/DefaultApi.md +84 -0
- data/docs/Error.md +20 -0
- data/docs/ErrorMessage.md +20 -0
- data/docs/FirewallRule.md +26 -0
- data/docs/FirewallRules.md +30 -0
- data/docs/FirewallruleProperties.md +34 -0
- data/docs/Group.md +26 -0
- data/docs/GroupEntities.md +20 -0
- data/docs/GroupMembers.md +24 -0
- data/docs/GroupProperties.md +36 -0
- data/docs/GroupShare.md +24 -0
- data/docs/GroupShareProperties.md +20 -0
- data/docs/GroupShares.md +24 -0
- data/docs/GroupUsers.md +24 -0
- data/docs/Groups.md +24 -0
- data/docs/IPBlocksApi.md +513 -0
- data/docs/IPFailover.md +20 -0
- data/docs/Image.md +26 -0
- data/docs/ImageApi.md +429 -0
- data/docs/ImageProperties.md +50 -0
- data/docs/Images.md +24 -0
- data/docs/Info.md +22 -0
- data/docs/IpBlock.md +26 -0
- data/docs/IpBlockProperties.md +26 -0
- data/docs/IpBlocks.md +24 -0
- data/docs/IpConsumer.md +30 -0
- data/docs/KubernetesApi.md +1513 -0
- data/docs/KubernetesAutoScaling.md +20 -0
- data/docs/KubernetesCluster.md +28 -0
- data/docs/KubernetesClusterEntities.md +18 -0
- data/docs/KubernetesClusterProperties.md +26 -0
- data/docs/KubernetesClusterPropertiesForPostAndPut.md +22 -0
- data/docs/KubernetesClusters.md +24 -0
- data/docs/KubernetesConfig.md +24 -0
- data/docs/KubernetesConfigProperties.md +18 -0
- data/docs/KubernetesMaintenanceWindow.md +20 -0
- data/docs/KubernetesNode.md +26 -0
- data/docs/KubernetesNodeMetadata.md +26 -0
- data/docs/KubernetesNodePool.md +26 -0
- data/docs/KubernetesNodePoolForPut.md +26 -0
- data/docs/KubernetesNodePoolLan.md +18 -0
- data/docs/KubernetesNodePoolProperties.md +50 -0
- data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
- data/docs/KubernetesNodePoolPropertiesForPut.md +48 -0
- data/docs/KubernetesNodePools.md +24 -0
- data/docs/KubernetesNodeProperties.md +22 -0
- data/docs/KubernetesNodes.md +24 -0
- data/docs/Label.md +26 -0
- data/docs/LabelApi.md +2355 -0
- data/docs/LabelProperties.md +26 -0
- data/docs/LabelResource.md +26 -0
- data/docs/LabelResourceProperties.md +20 -0
- data/docs/LabelResources.md +30 -0
- data/docs/Labels.md +24 -0
- data/docs/Lan.md +28 -0
- data/docs/LanApi.md +795 -0
- data/docs/LanEntities.md +18 -0
- data/docs/LanNics.md +30 -0
- data/docs/LanPost.md +28 -0
- data/docs/LanProperties.md +24 -0
- data/docs/LanPropertiesPost.md +24 -0
- data/docs/Lans.md +30 -0
- data/docs/LoadBalancerApi.md +883 -0
- data/docs/Loadbalancer.md +28 -0
- data/docs/LoadbalancerEntities.md +18 -0
- data/docs/LoadbalancerProperties.md +22 -0
- data/docs/Loadbalancers.md +30 -0
- data/docs/Location.md +26 -0
- data/docs/LocationApi.md +259 -0
- data/docs/LocationProperties.md +22 -0
- data/docs/Locations.md +24 -0
- data/docs/Nic.md +28 -0
- data/docs/NicApi.md +1087 -0
- data/docs/NicEntities.md +18 -0
- data/docs/NicProperties.md +30 -0
- data/docs/Nics.md +30 -0
- data/docs/NoStateMetaData.md +30 -0
- data/docs/PaginationLinks.md +22 -0
- data/docs/Peer.md +26 -0
- data/docs/PrivateCrossConnect.md +26 -0
- data/docs/PrivateCrossConnectApi.md +427 -0
- data/docs/PrivateCrossConnectProperties.md +24 -0
- data/docs/PrivateCrossConnects.md +24 -0
- data/docs/README.md +111 -0
- data/docs/Request.md +26 -0
- data/docs/RequestApi.md +267 -0
- data/docs/RequestMetadata.md +24 -0
- data/docs/RequestProperties.md +24 -0
- data/docs/RequestStatus.md +24 -0
- data/docs/RequestStatusMetadata.md +24 -0
- data/docs/RequestTarget.md +20 -0
- data/docs/Requests.md +30 -0
- data/docs/Resource.md +28 -0
- data/docs/ResourceEntities.md +18 -0
- data/docs/ResourceGroups.md +24 -0
- data/docs/ResourceLimits.md +50 -0
- data/docs/ResourceProperties.md +20 -0
- data/docs/ResourceReference.md +22 -0
- data/docs/Resources.md +24 -0
- data/docs/ResourcesUsers.md +24 -0
- data/docs/S3Key.md +26 -0
- data/docs/S3KeyMetadata.md +20 -0
- data/docs/S3KeyProperties.md +20 -0
- data/docs/S3Keys.md +24 -0
- data/docs/S3ObjectStorageSSO.md +18 -0
- data/docs/Server.md +28 -0
- data/docs/ServerApi.md +1573 -0
- data/docs/ServerEntities.md +22 -0
- data/docs/ServerProperties.md +32 -0
- data/docs/Servers.md +30 -0
- data/docs/Snapshot.md +26 -0
- data/docs/SnapshotApi.md +429 -0
- data/docs/SnapshotProperties.md +48 -0
- data/docs/Snapshots.md +24 -0
- data/docs/Type.md +15 -0
- data/docs/User.md +28 -0
- data/docs/UserManagementApi.md +2547 -0
- data/docs/UserMetadata.md +22 -0
- data/docs/UserProperties.md +34 -0
- data/docs/Users.md +24 -0
- data/docs/UsersEntities.md +20 -0
- data/docs/Volume.md +26 -0
- data/docs/VolumeApi.md +711 -0
- data/docs/VolumeProperties.md +54 -0
- data/docs/Volumes.md +30 -0
- data/docs/summary.md +295 -0
- data/gitbook.yaml +4 -0
- data/lib/ionoscloud/api/_api.rb +1 -1
- data/lib/ionoscloud/api_client.rb +1 -4
- data/lib/ionoscloud/models/backup_units.rb +2 -2
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +2 -2
- data/lib/ionoscloud/models/firewallrule_properties.rb +36 -21
- data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
- data/lib/ionoscloud/models/label_resources.rb +2 -2
- data/lib/ionoscloud/models/labels.rb +2 -2
- data/lib/ionoscloud/models/loadbalancer_properties.rb +12 -29
- data/lib/ionoscloud/models/type.rb +1 -0
- data/lib/ionoscloud/models/volume_properties.rb +14 -4
- data/lib/ionoscloud/version.rb +1 -1
- data/spec/models/backup_units_spec.rb +1 -1
- data/spec/models/datacenter_element_metadata_spec.rb +1 -1
- data/spec/models/firewallrule_properties_spec.rb +0 -12
- data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
- data/spec/models/kubernetes_node_spec.rb +1 -1
- data/spec/models/kubernetes_nodes_spec.rb +1 -1
- data/spec/models/label_resources_spec.rb +1 -1
- data/spec/models/labels_spec.rb +1 -1
- data/spec/models/loadbalancer_properties_spec.rb +0 -4
- data/spec/models/volume_properties_spec.rb +6 -0
- metadata +264 -120
- data/DOCS.md +0 -14618
- data/README.md +0 -55
data/docs/IPFailover.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# IPFailover
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ip** | **String** | | [optional] |
|
8
|
+
| **nic_uuid** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ionoscloud'
|
14
|
+
|
15
|
+
instance = Ionoscloud::IPFailover.new(
|
16
|
+
ip: 192.18.2.231,
|
17
|
+
nic_uuid: 3c11273c-b3e1-4ca3-8134-84fd2dd4ebec
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/Image.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# Image
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
|
11
|
+
| **properties** | [**ImageProperties**](ImageProperties.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::Image.new(
|
19
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
20
|
+
type: "image",
|
21
|
+
href: <RESOURCE-URI>,
|
22
|
+
metadata: null,
|
23
|
+
properties: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/ImageApi.md
ADDED
@@ -0,0 +1,429 @@
|
|
1
|
+
# ImageApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**images_delete**](ImageApi.md#images_delete) | **DELETE** /images/{imageId} | Delete an Image |
|
8
|
+
| [**images_find_by_id**](ImageApi.md#images_find_by_id) | **GET** /images/{imageId} | Retrieve an Image |
|
9
|
+
| [**images_get**](ImageApi.md#images_get) | **GET** /images | List Images |
|
10
|
+
| [**images_patch**](ImageApi.md#images_patch) | **PATCH** /images/{imageId} | Partially modify an Image |
|
11
|
+
| [**images_put**](ImageApi.md#images_put) | **PUT** /images/{imageId} | Modify an Image |
|
12
|
+
|
13
|
+
|
14
|
+
## images_delete
|
15
|
+
|
16
|
+
> Object images_delete(image_id, opts)
|
17
|
+
|
18
|
+
Delete an Image
|
19
|
+
|
20
|
+
Deletes the specified image. This operation is permitted on private image only.
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'ionoscloud'
|
27
|
+
# setup authorization
|
28
|
+
Ionoscloud.configure do |config|
|
29
|
+
# Configure HTTP basic authorization: Basic Authentication
|
30
|
+
config.username = 'YOUR USERNAME'
|
31
|
+
config.password = 'YOUR PASSWORD'
|
32
|
+
|
33
|
+
# Configure API key authorization: Token Authentication
|
34
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
36
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
37
|
+
end
|
38
|
+
|
39
|
+
api_instance = Ionoscloud::ImageApi.new
|
40
|
+
image_id = 'image_id_example' # String |
|
41
|
+
opts = {
|
42
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
43
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
|
44
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
45
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
# Delete an Image
|
49
|
+
result = api_instance.images_delete(image_id, opts)
|
50
|
+
p result
|
51
|
+
rescue Ionoscloud::ApiError => e
|
52
|
+
puts "Error when calling ImageApi->images_delete: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
#### Using the images_delete_with_http_info variant
|
57
|
+
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
59
|
+
|
60
|
+
> <Array(Object, Integer, Hash)> images_delete_with_http_info(image_id, opts)
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
begin
|
64
|
+
# Delete an Image
|
65
|
+
data, status_code, headers = api_instance.images_delete_with_http_info(image_id, opts)
|
66
|
+
p status_code # => 2xx
|
67
|
+
p headers # => { ... }
|
68
|
+
p data # => Object
|
69
|
+
rescue Ionoscloud::ApiError => e
|
70
|
+
puts "Error when calling ImageApi->images_delete_with_http_info: #{e}"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Parameters
|
75
|
+
|
76
|
+
| Name | Type | Description | Notes |
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
78
|
+
| **image_id** | **String** | | |
|
79
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
80
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
|
81
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
82
|
+
|
83
|
+
### Return type
|
84
|
+
|
85
|
+
**Object**
|
86
|
+
|
87
|
+
### Authorization
|
88
|
+
|
89
|
+
Basic Authentication, Token Authentication
|
90
|
+
|
91
|
+
### HTTP request headers
|
92
|
+
|
93
|
+
- **Content-Type**: Not defined
|
94
|
+
- **Accept**: application/json
|
95
|
+
|
96
|
+
|
97
|
+
## images_find_by_id
|
98
|
+
|
99
|
+
> <Image> images_find_by_id(image_id, opts)
|
100
|
+
|
101
|
+
Retrieve an Image
|
102
|
+
|
103
|
+
Retrieves the attributes of a given image.
|
104
|
+
|
105
|
+
### Examples
|
106
|
+
|
107
|
+
```ruby
|
108
|
+
require 'time'
|
109
|
+
require 'ionoscloud'
|
110
|
+
# setup authorization
|
111
|
+
Ionoscloud.configure do |config|
|
112
|
+
# Configure HTTP basic authorization: Basic Authentication
|
113
|
+
config.username = 'YOUR USERNAME'
|
114
|
+
config.password = 'YOUR PASSWORD'
|
115
|
+
|
116
|
+
# Configure API key authorization: Token Authentication
|
117
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
118
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
119
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
120
|
+
end
|
121
|
+
|
122
|
+
api_instance = Ionoscloud::ImageApi.new
|
123
|
+
image_id = 'image_id_example' # String |
|
124
|
+
opts = {
|
125
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
126
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
|
127
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
128
|
+
}
|
129
|
+
|
130
|
+
begin
|
131
|
+
# Retrieve an Image
|
132
|
+
result = api_instance.images_find_by_id(image_id, opts)
|
133
|
+
p result
|
134
|
+
rescue Ionoscloud::ApiError => e
|
135
|
+
puts "Error when calling ImageApi->images_find_by_id: #{e}"
|
136
|
+
end
|
137
|
+
```
|
138
|
+
|
139
|
+
#### Using the images_find_by_id_with_http_info variant
|
140
|
+
|
141
|
+
This returns an Array which contains the response data, status code and headers.
|
142
|
+
|
143
|
+
> <Array(<Image>, Integer, Hash)> images_find_by_id_with_http_info(image_id, opts)
|
144
|
+
|
145
|
+
```ruby
|
146
|
+
begin
|
147
|
+
# Retrieve an Image
|
148
|
+
data, status_code, headers = api_instance.images_find_by_id_with_http_info(image_id, opts)
|
149
|
+
p status_code # => 2xx
|
150
|
+
p headers # => { ... }
|
151
|
+
p data # => <Image>
|
152
|
+
rescue Ionoscloud::ApiError => e
|
153
|
+
puts "Error when calling ImageApi->images_find_by_id_with_http_info: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
|
159
|
+
| Name | Type | Description | Notes |
|
160
|
+
| ---- | ---- | ----------- | ----- |
|
161
|
+
| **image_id** | **String** | | |
|
162
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
163
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
|
164
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
165
|
+
|
166
|
+
### Return type
|
167
|
+
|
168
|
+
[**Image**](Image.md)
|
169
|
+
|
170
|
+
### Authorization
|
171
|
+
|
172
|
+
Basic Authentication, Token Authentication
|
173
|
+
|
174
|
+
### HTTP request headers
|
175
|
+
|
176
|
+
- **Content-Type**: Not defined
|
177
|
+
- **Accept**: application/json
|
178
|
+
|
179
|
+
|
180
|
+
## images_get
|
181
|
+
|
182
|
+
> <Images> images_get(opts)
|
183
|
+
|
184
|
+
List Images
|
185
|
+
|
186
|
+
Retrieve a list of images within the datacenter
|
187
|
+
|
188
|
+
### Examples
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
require 'time'
|
192
|
+
require 'ionoscloud'
|
193
|
+
# setup authorization
|
194
|
+
Ionoscloud.configure do |config|
|
195
|
+
# Configure HTTP basic authorization: Basic Authentication
|
196
|
+
config.username = 'YOUR USERNAME'
|
197
|
+
config.password = 'YOUR PASSWORD'
|
198
|
+
|
199
|
+
# Configure API key authorization: Token Authentication
|
200
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
201
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
202
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
203
|
+
end
|
204
|
+
|
205
|
+
api_instance = Ionoscloud::ImageApi.new
|
206
|
+
opts = {
|
207
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
208
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
|
209
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
210
|
+
}
|
211
|
+
|
212
|
+
begin
|
213
|
+
# List Images
|
214
|
+
result = api_instance.images_get(opts)
|
215
|
+
p result
|
216
|
+
rescue Ionoscloud::ApiError => e
|
217
|
+
puts "Error when calling ImageApi->images_get: #{e}"
|
218
|
+
end
|
219
|
+
```
|
220
|
+
|
221
|
+
#### Using the images_get_with_http_info variant
|
222
|
+
|
223
|
+
This returns an Array which contains the response data, status code and headers.
|
224
|
+
|
225
|
+
> <Array(<Images>, Integer, Hash)> images_get_with_http_info(opts)
|
226
|
+
|
227
|
+
```ruby
|
228
|
+
begin
|
229
|
+
# List Images
|
230
|
+
data, status_code, headers = api_instance.images_get_with_http_info(opts)
|
231
|
+
p status_code # => 2xx
|
232
|
+
p headers # => { ... }
|
233
|
+
p data # => <Images>
|
234
|
+
rescue Ionoscloud::ApiError => e
|
235
|
+
puts "Error when calling ImageApi->images_get_with_http_info: #{e}"
|
236
|
+
end
|
237
|
+
```
|
238
|
+
|
239
|
+
### Parameters
|
240
|
+
|
241
|
+
| Name | Type | Description | Notes |
|
242
|
+
| ---- | ---- | ----------- | ----- |
|
243
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
244
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
|
245
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
246
|
+
|
247
|
+
### Return type
|
248
|
+
|
249
|
+
[**Images**](Images.md)
|
250
|
+
|
251
|
+
### Authorization
|
252
|
+
|
253
|
+
Basic Authentication, Token Authentication
|
254
|
+
|
255
|
+
### HTTP request headers
|
256
|
+
|
257
|
+
- **Content-Type**: Not defined
|
258
|
+
- **Accept**: application/json
|
259
|
+
|
260
|
+
|
261
|
+
## images_patch
|
262
|
+
|
263
|
+
> <Image> images_patch(image_id, image, opts)
|
264
|
+
|
265
|
+
Partially modify an Image
|
266
|
+
|
267
|
+
You can use update attributes of a resource
|
268
|
+
|
269
|
+
### Examples
|
270
|
+
|
271
|
+
```ruby
|
272
|
+
require 'time'
|
273
|
+
require 'ionoscloud'
|
274
|
+
# setup authorization
|
275
|
+
Ionoscloud.configure do |config|
|
276
|
+
# Configure HTTP basic authorization: Basic Authentication
|
277
|
+
config.username = 'YOUR USERNAME'
|
278
|
+
config.password = 'YOUR PASSWORD'
|
279
|
+
|
280
|
+
# Configure API key authorization: Token Authentication
|
281
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
282
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
283
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
284
|
+
end
|
285
|
+
|
286
|
+
api_instance = Ionoscloud::ImageApi.new
|
287
|
+
image_id = 'image_id_example' # String |
|
288
|
+
image = Ionoscloud::ImageProperties.new({licence_type: 'UNKNOWN'}) # ImageProperties | Modified Image
|
289
|
+
opts = {
|
290
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
291
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
|
292
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
293
|
+
}
|
294
|
+
|
295
|
+
begin
|
296
|
+
# Partially modify an Image
|
297
|
+
result = api_instance.images_patch(image_id, image, opts)
|
298
|
+
p result
|
299
|
+
rescue Ionoscloud::ApiError => e
|
300
|
+
puts "Error when calling ImageApi->images_patch: #{e}"
|
301
|
+
end
|
302
|
+
```
|
303
|
+
|
304
|
+
#### Using the images_patch_with_http_info variant
|
305
|
+
|
306
|
+
This returns an Array which contains the response data, status code and headers.
|
307
|
+
|
308
|
+
> <Array(<Image>, Integer, Hash)> images_patch_with_http_info(image_id, image, opts)
|
309
|
+
|
310
|
+
```ruby
|
311
|
+
begin
|
312
|
+
# Partially modify an Image
|
313
|
+
data, status_code, headers = api_instance.images_patch_with_http_info(image_id, image, opts)
|
314
|
+
p status_code # => 2xx
|
315
|
+
p headers # => { ... }
|
316
|
+
p data # => <Image>
|
317
|
+
rescue Ionoscloud::ApiError => e
|
318
|
+
puts "Error when calling ImageApi->images_patch_with_http_info: #{e}"
|
319
|
+
end
|
320
|
+
```
|
321
|
+
|
322
|
+
### Parameters
|
323
|
+
|
324
|
+
| Name | Type | Description | Notes |
|
325
|
+
| ---- | ---- | ----------- | ----- |
|
326
|
+
| **image_id** | **String** | | |
|
327
|
+
| **image** | [**ImageProperties**](ImageProperties.md) | Modified Image | |
|
328
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
329
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
|
330
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
331
|
+
|
332
|
+
### Return type
|
333
|
+
|
334
|
+
[**Image**](Image.md)
|
335
|
+
|
336
|
+
### Authorization
|
337
|
+
|
338
|
+
Basic Authentication, Token Authentication
|
339
|
+
|
340
|
+
### HTTP request headers
|
341
|
+
|
342
|
+
- **Content-Type**: application/json
|
343
|
+
- **Accept**: application/json
|
344
|
+
|
345
|
+
|
346
|
+
## images_put
|
347
|
+
|
348
|
+
> <Image> images_put(image_id, image, opts)
|
349
|
+
|
350
|
+
Modify an Image
|
351
|
+
|
352
|
+
You can use update attributes of a resource
|
353
|
+
|
354
|
+
### Examples
|
355
|
+
|
356
|
+
```ruby
|
357
|
+
require 'time'
|
358
|
+
require 'ionoscloud'
|
359
|
+
# setup authorization
|
360
|
+
Ionoscloud.configure do |config|
|
361
|
+
# Configure HTTP basic authorization: Basic Authentication
|
362
|
+
config.username = 'YOUR USERNAME'
|
363
|
+
config.password = 'YOUR PASSWORD'
|
364
|
+
|
365
|
+
# Configure API key authorization: Token Authentication
|
366
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
367
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
368
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
369
|
+
end
|
370
|
+
|
371
|
+
api_instance = Ionoscloud::ImageApi.new
|
372
|
+
image_id = 'image_id_example' # String |
|
373
|
+
image = Ionoscloud::Image.new({properties: Ionoscloud::ImageProperties.new({licence_type: 'UNKNOWN'})}) # Image | Modified Image
|
374
|
+
opts = {
|
375
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
376
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
|
377
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
378
|
+
}
|
379
|
+
|
380
|
+
begin
|
381
|
+
# Modify an Image
|
382
|
+
result = api_instance.images_put(image_id, image, opts)
|
383
|
+
p result
|
384
|
+
rescue Ionoscloud::ApiError => e
|
385
|
+
puts "Error when calling ImageApi->images_put: #{e}"
|
386
|
+
end
|
387
|
+
```
|
388
|
+
|
389
|
+
#### Using the images_put_with_http_info variant
|
390
|
+
|
391
|
+
This returns an Array which contains the response data, status code and headers.
|
392
|
+
|
393
|
+
> <Array(<Image>, Integer, Hash)> images_put_with_http_info(image_id, image, opts)
|
394
|
+
|
395
|
+
```ruby
|
396
|
+
begin
|
397
|
+
# Modify an Image
|
398
|
+
data, status_code, headers = api_instance.images_put_with_http_info(image_id, image, opts)
|
399
|
+
p status_code # => 2xx
|
400
|
+
p headers # => { ... }
|
401
|
+
p data # => <Image>
|
402
|
+
rescue Ionoscloud::ApiError => e
|
403
|
+
puts "Error when calling ImageApi->images_put_with_http_info: #{e}"
|
404
|
+
end
|
405
|
+
```
|
406
|
+
|
407
|
+
### Parameters
|
408
|
+
|
409
|
+
| Name | Type | Description | Notes |
|
410
|
+
| ---- | ---- | ----------- | ----- |
|
411
|
+
| **image_id** | **String** | | |
|
412
|
+
| **image** | [**Image**](Image.md) | Modified Image | |
|
413
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
414
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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] |
|
415
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
416
|
+
|
417
|
+
### Return type
|
418
|
+
|
419
|
+
[**Image**](Image.md)
|
420
|
+
|
421
|
+
### Authorization
|
422
|
+
|
423
|
+
Basic Authentication, Token Authentication
|
424
|
+
|
425
|
+
### HTTP request headers
|
426
|
+
|
427
|
+
- **Content-Type**: application/json
|
428
|
+
- **Accept**: application/json
|
429
|
+
|