ionoscloud 5.0.0 → 5.0.1

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 (174) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AttachedVolumes.md +30 -0
  3. data/docs/BackupUnit.md +26 -0
  4. data/docs/BackupUnitApi.md +595 -0
  5. data/docs/BackupUnitProperties.md +22 -0
  6. data/docs/BackupUnitSSO.md +18 -0
  7. data/docs/BackupUnits.md +24 -0
  8. data/docs/BalancedNics.md +30 -0
  9. data/docs/CHANGELOG.md +1 -0
  10. data/docs/Cdroms.md +30 -0
  11. data/docs/ConnectableDatacenter.md +22 -0
  12. data/docs/Contract.md +20 -0
  13. data/docs/ContractApi.md +89 -0
  14. data/docs/ContractProperties.md +26 -0
  15. data/docs/DataCenterApi.md +517 -0
  16. data/docs/DataCenterEntities.md +24 -0
  17. data/docs/Datacenter.md +28 -0
  18. data/docs/DatacenterElementMetadata.md +32 -0
  19. data/docs/DatacenterProperties.md +28 -0
  20. data/docs/Datacenters.md +30 -0
  21. data/docs/DefaultApi.md +84 -0
  22. data/docs/Error.md +20 -0
  23. data/docs/ErrorMessage.md +20 -0
  24. data/docs/FirewallRule.md +26 -0
  25. data/docs/FirewallRules.md +30 -0
  26. data/docs/FirewallruleProperties.md +34 -0
  27. data/docs/Group.md +26 -0
  28. data/docs/GroupEntities.md +20 -0
  29. data/docs/GroupMembers.md +24 -0
  30. data/docs/GroupProperties.md +36 -0
  31. data/docs/GroupShare.md +24 -0
  32. data/docs/GroupShareProperties.md +20 -0
  33. data/docs/GroupShares.md +24 -0
  34. data/docs/GroupUsers.md +24 -0
  35. data/docs/Groups.md +24 -0
  36. data/docs/IPBlocksApi.md +513 -0
  37. data/docs/IPFailover.md +20 -0
  38. data/docs/Image.md +26 -0
  39. data/docs/ImageApi.md +429 -0
  40. data/docs/ImageProperties.md +50 -0
  41. data/docs/Images.md +24 -0
  42. data/docs/Info.md +22 -0
  43. data/docs/IpBlock.md +26 -0
  44. data/docs/IpBlockProperties.md +26 -0
  45. data/docs/IpBlocks.md +24 -0
  46. data/docs/IpConsumer.md +30 -0
  47. data/docs/KubernetesApi.md +1513 -0
  48. data/docs/KubernetesAutoScaling.md +20 -0
  49. data/docs/KubernetesCluster.md +28 -0
  50. data/docs/KubernetesClusterEntities.md +18 -0
  51. data/docs/KubernetesClusterProperties.md +26 -0
  52. data/docs/KubernetesClusterPropertiesForPostAndPut.md +22 -0
  53. data/docs/KubernetesClusters.md +24 -0
  54. data/docs/KubernetesConfig.md +24 -0
  55. data/docs/KubernetesConfigProperties.md +18 -0
  56. data/docs/KubernetesMaintenanceWindow.md +20 -0
  57. data/docs/KubernetesNode.md +26 -0
  58. data/docs/KubernetesNodeMetadata.md +26 -0
  59. data/docs/KubernetesNodePool.md +26 -0
  60. data/docs/KubernetesNodePoolForPut.md +26 -0
  61. data/docs/KubernetesNodePoolLan.md +18 -0
  62. data/docs/KubernetesNodePoolProperties.md +50 -0
  63. data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
  64. data/docs/KubernetesNodePoolPropertiesForPut.md +48 -0
  65. data/docs/KubernetesNodePools.md +24 -0
  66. data/docs/KubernetesNodeProperties.md +22 -0
  67. data/docs/KubernetesNodes.md +24 -0
  68. data/docs/Label.md +26 -0
  69. data/docs/LabelApi.md +2355 -0
  70. data/docs/LabelProperties.md +26 -0
  71. data/docs/LabelResource.md +26 -0
  72. data/docs/LabelResourceProperties.md +20 -0
  73. data/docs/LabelResources.md +30 -0
  74. data/docs/Labels.md +24 -0
  75. data/docs/Lan.md +28 -0
  76. data/docs/LanApi.md +795 -0
  77. data/docs/LanEntities.md +18 -0
  78. data/docs/LanNics.md +30 -0
  79. data/docs/LanPost.md +28 -0
  80. data/docs/LanProperties.md +24 -0
  81. data/docs/LanPropertiesPost.md +24 -0
  82. data/docs/Lans.md +30 -0
  83. data/docs/LoadBalancerApi.md +883 -0
  84. data/docs/Loadbalancer.md +28 -0
  85. data/docs/LoadbalancerEntities.md +18 -0
  86. data/docs/LoadbalancerProperties.md +22 -0
  87. data/docs/Loadbalancers.md +30 -0
  88. data/docs/Location.md +26 -0
  89. data/docs/LocationApi.md +259 -0
  90. data/docs/LocationProperties.md +22 -0
  91. data/docs/Locations.md +24 -0
  92. data/docs/Nic.md +28 -0
  93. data/docs/NicApi.md +1087 -0
  94. data/docs/NicEntities.md +18 -0
  95. data/docs/NicProperties.md +30 -0
  96. data/docs/Nics.md +30 -0
  97. data/docs/NoStateMetaData.md +30 -0
  98. data/docs/PaginationLinks.md +22 -0
  99. data/docs/Peer.md +26 -0
  100. data/docs/PrivateCrossConnect.md +26 -0
  101. data/docs/PrivateCrossConnectApi.md +427 -0
  102. data/docs/PrivateCrossConnectProperties.md +24 -0
  103. data/docs/PrivateCrossConnects.md +24 -0
  104. data/docs/README.md +111 -0
  105. data/docs/Request.md +26 -0
  106. data/docs/RequestApi.md +267 -0
  107. data/docs/RequestMetadata.md +24 -0
  108. data/docs/RequestProperties.md +24 -0
  109. data/docs/RequestStatus.md +24 -0
  110. data/docs/RequestStatusMetadata.md +24 -0
  111. data/docs/RequestTarget.md +20 -0
  112. data/docs/Requests.md +30 -0
  113. data/docs/Resource.md +28 -0
  114. data/docs/ResourceEntities.md +18 -0
  115. data/docs/ResourceGroups.md +24 -0
  116. data/docs/ResourceLimits.md +50 -0
  117. data/docs/ResourceProperties.md +20 -0
  118. data/docs/ResourceReference.md +22 -0
  119. data/docs/Resources.md +24 -0
  120. data/docs/ResourcesUsers.md +24 -0
  121. data/docs/S3Key.md +26 -0
  122. data/docs/S3KeyMetadata.md +20 -0
  123. data/docs/S3KeyProperties.md +20 -0
  124. data/docs/S3Keys.md +24 -0
  125. data/docs/S3ObjectStorageSSO.md +18 -0
  126. data/docs/Server.md +28 -0
  127. data/docs/ServerApi.md +1573 -0
  128. data/docs/ServerEntities.md +22 -0
  129. data/docs/ServerProperties.md +32 -0
  130. data/docs/Servers.md +30 -0
  131. data/docs/Snapshot.md +26 -0
  132. data/docs/SnapshotApi.md +429 -0
  133. data/docs/SnapshotProperties.md +48 -0
  134. data/docs/Snapshots.md +24 -0
  135. data/docs/Type.md +15 -0
  136. data/docs/User.md +28 -0
  137. data/docs/UserManagementApi.md +2547 -0
  138. data/docs/UserMetadata.md +22 -0
  139. data/docs/UserProperties.md +34 -0
  140. data/docs/Users.md +24 -0
  141. data/docs/UsersEntities.md +20 -0
  142. data/docs/Volume.md +26 -0
  143. data/docs/VolumeApi.md +711 -0
  144. data/docs/VolumeProperties.md +54 -0
  145. data/docs/Volumes.md +30 -0
  146. data/docs/summary.md +295 -0
  147. data/gitbook.yaml +4 -0
  148. data/lib/ionoscloud/api/_api.rb +1 -1
  149. data/lib/ionoscloud/api_client.rb +1 -4
  150. data/lib/ionoscloud/models/backup_units.rb +2 -2
  151. data/lib/ionoscloud/models/datacenter_element_metadata.rb +2 -2
  152. data/lib/ionoscloud/models/firewallrule_properties.rb +36 -21
  153. data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
  154. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +2 -2
  155. data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
  156. data/lib/ionoscloud/models/label_resources.rb +2 -2
  157. data/lib/ionoscloud/models/labels.rb +2 -2
  158. data/lib/ionoscloud/models/loadbalancer_properties.rb +12 -29
  159. data/lib/ionoscloud/models/type.rb +1 -0
  160. data/lib/ionoscloud/models/volume_properties.rb +14 -4
  161. data/lib/ionoscloud/version.rb +1 -1
  162. data/spec/models/backup_units_spec.rb +1 -1
  163. data/spec/models/datacenter_element_metadata_spec.rb +1 -1
  164. data/spec/models/firewallrule_properties_spec.rb +0 -12
  165. data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
  166. data/spec/models/kubernetes_node_spec.rb +1 -1
  167. data/spec/models/kubernetes_nodes_spec.rb +1 -1
  168. data/spec/models/label_resources_spec.rb +1 -1
  169. data/spec/models/labels_spec.rb +1 -1
  170. data/spec/models/loadbalancer_properties_spec.rb +0 -4
  171. data/spec/models/volume_properties_spec.rb +6 -0
  172. metadata +264 -120
  173. data/DOCS.md +0 -14618
  174. data/README.md +0 -55
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4024357ab13ae688d6baea2f0549d9b971874ef781800b90458864fb00507db5
4
- data.tar.gz: 6c6d81bf45d3be9ea5410d94cef3083adc81e341144e22e7c087729261f44b03
3
+ metadata.gz: 9b8ffe371acfd81b6d2f286a03fa54ea84ca5bcba056ca636ceaadf2e591d59e
4
+ data.tar.gz: 4088a48c95354e3505acba36e091ea5eee8889029bd2937228ff2f5ff9046147
5
5
  SHA512:
6
- metadata.gz: 56577cf97195e1ec9ed5b8d4800fd361a8398767f71dd09e88044b2f9a2390bc664ed75b2ea5c119d9773dae213c7c44f5a9fb5f6a0c4f9198541845a61e14d0
7
- data.tar.gz: 98c8b6e5b42e0ab7c15c2828c911eabe4d3b17201acf2bd53e03802459eb6f4aa3cf3124c960480148641954fdb1d036fd07dd96e964cf3166659f2e861e9d3d
6
+ metadata.gz: 51b38ddf37c1235b631e934102b3e75954e9b20e65cccc774af31f562e8d3879079849cb12e417b73dc2ee39967c07e4f5f7c2e24ca625486619fa99b19e8a7c
7
+ data.tar.gz: f7d8ebd0ac7a7888cdbe4451243284a4f025464290f77e905b1853b76b746894332c56e0a1bf38a83288cdc7b2183aabe665a53bd48b219c6ccaf4e957211517
@@ -0,0 +1,30 @@
1
+ # AttachedVolumes
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
+ | **items** | [**Array<Volume>**](Volume.md) | Array of items in that collection | [optional] |
11
+ | **offset** | **Float** | the offset (if specified in the request) | [optional] |
12
+ | **limit** | **Float** | the limit (if specified in the request) | [optional] |
13
+ | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ionoscloud'
19
+
20
+ instance = Ionoscloud::AttachedVolumes.new(
21
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
22
+ type: "collection",
23
+ href: <RESOURCE-URI>,
24
+ items: null,
25
+ offset: 0,
26
+ limit: 1000,
27
+ _links: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,26 @@
1
+ # BackupUnit
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The resource&#39;s unique identifier | [optional][readonly] |
8
+ | **type** | **String** | The type of object that has been created | [optional][readonly] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
11
+ | **properties** | [**BackupUnitProperties**](BackupUnitProperties.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ionoscloud'
17
+
18
+ instance = Ionoscloud::BackupUnit.new(
19
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
20
+ type: null,
21
+ href: <RESOURCE-URI>,
22
+ metadata: null,
23
+ properties: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,595 @@
1
+ # BackupUnitApi
2
+
3
+ All URIs are relative to *https://api.ionos.com/cloudapi/v5*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**backupunits_delete**](BackupUnitApi.md#backupunits_delete) | **DELETE** /backupunits/{backupunitId} | Delete a Backup Unit |
8
+ | [**backupunits_find_by_id**](BackupUnitApi.md#backupunits_find_by_id) | **GET** /backupunits/{backupunitId} | Returns the specified backup Unit |
9
+ | [**backupunits_get**](BackupUnitApi.md#backupunits_get) | **GET** /backupunits | List Backup Units |
10
+ | [**backupunits_patch**](BackupUnitApi.md#backupunits_patch) | **PATCH** /backupunits/{backupunitId} | Partially modify a Backup Unit |
11
+ | [**backupunits_post**](BackupUnitApi.md#backupunits_post) | **POST** /backupunits | Create a Backup Unit |
12
+ | [**backupunits_put**](BackupUnitApi.md#backupunits_put) | **PUT** /backupunits/{backupunitId} | Modify a Backup Unit |
13
+ | [**backupunits_ssourl_get**](BackupUnitApi.md#backupunits_ssourl_get) | **GET** /backupunits/{backupunitId}/ssourl | Returns a single signon URL for the specified backup Unit. |
14
+
15
+
16
+ ## backupunits_delete
17
+
18
+ > Object backupunits_delete(backupunit_id, opts)
19
+
20
+ Delete a Backup Unit
21
+
22
+ NOTE: Running through the deletion process will delete: - the backup plans inside the Backup Unit. - all backups associated with the Backup Unit. - the backup user and finally also the unit
23
+
24
+ ### Examples
25
+
26
+ ```ruby
27
+ require 'time'
28
+ require 'ionoscloud'
29
+ # setup authorization
30
+ Ionoscloud.configure do |config|
31
+ # Configure HTTP basic authorization: Basic Authentication
32
+ config.username = 'YOUR USERNAME'
33
+ config.password = 'YOUR PASSWORD'
34
+
35
+ # Configure API key authorization: Token Authentication
36
+ config.api_key['Authorization'] = 'YOUR API KEY'
37
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
+ # config.api_key_prefix['Authorization'] = 'Bearer'
39
+ end
40
+
41
+ api_instance = Ionoscloud::BackupUnitApi.new
42
+ backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup Unit
43
+ opts = {
44
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
45
+ 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
46
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
47
+ }
48
+
49
+ begin
50
+ # Delete a Backup Unit
51
+ result = api_instance.backupunits_delete(backupunit_id, opts)
52
+ p result
53
+ rescue Ionoscloud::ApiError => e
54
+ puts "Error when calling BackupUnitApi->backupunits_delete: #{e}"
55
+ end
56
+ ```
57
+
58
+ #### Using the backupunits_delete_with_http_info variant
59
+
60
+ This returns an Array which contains the response data, status code and headers.
61
+
62
+ > <Array(Object, Integer, Hash)> backupunits_delete_with_http_info(backupunit_id, opts)
63
+
64
+ ```ruby
65
+ begin
66
+ # Delete a Backup Unit
67
+ data, status_code, headers = api_instance.backupunits_delete_with_http_info(backupunit_id, opts)
68
+ p status_code # => 2xx
69
+ p headers # => { ... }
70
+ p data # => Object
71
+ rescue Ionoscloud::ApiError => e
72
+ puts "Error when calling BackupUnitApi->backupunits_delete_with_http_info: #{e}"
73
+ end
74
+ ```
75
+
76
+ ### Parameters
77
+
78
+ | Name | Type | Description | Notes |
79
+ | ---- | ---- | ----------- | ----- |
80
+ | **backupunit_id** | **String** | The unique ID of the backup Unit | |
81
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
82
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
83
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
84
+
85
+ ### Return type
86
+
87
+ **Object**
88
+
89
+ ### Authorization
90
+
91
+ Basic Authentication, Token Authentication
92
+
93
+ ### HTTP request headers
94
+
95
+ - **Content-Type**: Not defined
96
+ - **Accept**: application/json
97
+
98
+
99
+ ## backupunits_find_by_id
100
+
101
+ > <BackupUnit> backupunits_find_by_id(backupunit_id, opts)
102
+
103
+ Returns the specified backup Unit
104
+
105
+ You can retrieve the details of an specific backup unit.
106
+
107
+ ### Examples
108
+
109
+ ```ruby
110
+ require 'time'
111
+ require 'ionoscloud'
112
+ # setup authorization
113
+ Ionoscloud.configure do |config|
114
+ # Configure HTTP basic authorization: Basic Authentication
115
+ config.username = 'YOUR USERNAME'
116
+ config.password = 'YOUR PASSWORD'
117
+
118
+ # Configure API key authorization: Token Authentication
119
+ config.api_key['Authorization'] = 'YOUR API KEY'
120
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
121
+ # config.api_key_prefix['Authorization'] = 'Bearer'
122
+ end
123
+
124
+ api_instance = Ionoscloud::BackupUnitApi.new
125
+ backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit
126
+ opts = {
127
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
128
+ 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
129
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
130
+ }
131
+
132
+ begin
133
+ # Returns the specified backup Unit
134
+ result = api_instance.backupunits_find_by_id(backupunit_id, opts)
135
+ p result
136
+ rescue Ionoscloud::ApiError => e
137
+ puts "Error when calling BackupUnitApi->backupunits_find_by_id: #{e}"
138
+ end
139
+ ```
140
+
141
+ #### Using the backupunits_find_by_id_with_http_info variant
142
+
143
+ This returns an Array which contains the response data, status code and headers.
144
+
145
+ > <Array(<BackupUnit>, Integer, Hash)> backupunits_find_by_id_with_http_info(backupunit_id, opts)
146
+
147
+ ```ruby
148
+ begin
149
+ # Returns the specified backup Unit
150
+ data, status_code, headers = api_instance.backupunits_find_by_id_with_http_info(backupunit_id, opts)
151
+ p status_code # => 2xx
152
+ p headers # => { ... }
153
+ p data # => <BackupUnit>
154
+ rescue Ionoscloud::ApiError => e
155
+ puts "Error when calling BackupUnitApi->backupunits_find_by_id_with_http_info: #{e}"
156
+ end
157
+ ```
158
+
159
+ ### Parameters
160
+
161
+ | Name | Type | Description | Notes |
162
+ | ---- | ---- | ----------- | ----- |
163
+ | **backupunit_id** | **String** | The unique ID of the backup unit | |
164
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
165
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
166
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
167
+
168
+ ### Return type
169
+
170
+ [**BackupUnit**](BackupUnit.md)
171
+
172
+ ### Authorization
173
+
174
+ Basic Authentication, Token Authentication
175
+
176
+ ### HTTP request headers
177
+
178
+ - **Content-Type**: Not defined
179
+ - **Accept**: application/json
180
+
181
+
182
+ ## backupunits_get
183
+
184
+ > <BackupUnits> backupunits_get(opts)
185
+
186
+ List Backup Units
187
+
188
+ You can retrieve a complete list of backup Units that you have access to.
189
+
190
+ ### Examples
191
+
192
+ ```ruby
193
+ require 'time'
194
+ require 'ionoscloud'
195
+ # setup authorization
196
+ Ionoscloud.configure do |config|
197
+ # Configure HTTP basic authorization: Basic Authentication
198
+ config.username = 'YOUR USERNAME'
199
+ config.password = 'YOUR PASSWORD'
200
+
201
+ # Configure API key authorization: Token Authentication
202
+ config.api_key['Authorization'] = 'YOUR API KEY'
203
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
204
+ # config.api_key_prefix['Authorization'] = 'Bearer'
205
+ end
206
+
207
+ api_instance = Ionoscloud::BackupUnitApi.new
208
+ opts = {
209
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
210
+ 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
211
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
212
+ }
213
+
214
+ begin
215
+ # List Backup Units
216
+ result = api_instance.backupunits_get(opts)
217
+ p result
218
+ rescue Ionoscloud::ApiError => e
219
+ puts "Error when calling BackupUnitApi->backupunits_get: #{e}"
220
+ end
221
+ ```
222
+
223
+ #### Using the backupunits_get_with_http_info variant
224
+
225
+ This returns an Array which contains the response data, status code and headers.
226
+
227
+ > <Array(<BackupUnits>, Integer, Hash)> backupunits_get_with_http_info(opts)
228
+
229
+ ```ruby
230
+ begin
231
+ # List Backup Units
232
+ data, status_code, headers = api_instance.backupunits_get_with_http_info(opts)
233
+ p status_code # => 2xx
234
+ p headers # => { ... }
235
+ p data # => <BackupUnits>
236
+ rescue Ionoscloud::ApiError => e
237
+ puts "Error when calling BackupUnitApi->backupunits_get_with_http_info: #{e}"
238
+ end
239
+ ```
240
+
241
+ ### Parameters
242
+
243
+ | Name | Type | Description | Notes |
244
+ | ---- | ---- | ----------- | ----- |
245
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
246
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
247
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
248
+
249
+ ### Return type
250
+
251
+ [**BackupUnits**](BackupUnits.md)
252
+
253
+ ### Authorization
254
+
255
+ Basic Authentication, Token Authentication
256
+
257
+ ### HTTP request headers
258
+
259
+ - **Content-Type**: Not defined
260
+ - **Accept**: application/json
261
+
262
+
263
+ ## backupunits_patch
264
+
265
+ > <BackupUnit> backupunits_patch(backupunit_id, backup_unit_properties, opts)
266
+
267
+ Partially modify a Backup Unit
268
+
269
+ You can use update a backup Unit properties
270
+
271
+ ### Examples
272
+
273
+ ```ruby
274
+ require 'time'
275
+ require 'ionoscloud'
276
+ # setup authorization
277
+ Ionoscloud.configure do |config|
278
+ # Configure HTTP basic authorization: Basic Authentication
279
+ config.username = 'YOUR USERNAME'
280
+ config.password = 'YOUR PASSWORD'
281
+
282
+ # Configure API key authorization: Token Authentication
283
+ config.api_key['Authorization'] = 'YOUR API KEY'
284
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
285
+ # config.api_key_prefix['Authorization'] = 'Bearer'
286
+ end
287
+
288
+ api_instance = Ionoscloud::BackupUnitApi.new
289
+ backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit
290
+ backup_unit_properties = Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'}) # BackupUnitProperties | Modified backup Unit properties
291
+ opts = {
292
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
293
+ 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
294
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
295
+ }
296
+
297
+ begin
298
+ # Partially modify a Backup Unit
299
+ result = api_instance.backupunits_patch(backupunit_id, backup_unit_properties, opts)
300
+ p result
301
+ rescue Ionoscloud::ApiError => e
302
+ puts "Error when calling BackupUnitApi->backupunits_patch: #{e}"
303
+ end
304
+ ```
305
+
306
+ #### Using the backupunits_patch_with_http_info variant
307
+
308
+ This returns an Array which contains the response data, status code and headers.
309
+
310
+ > <Array(<BackupUnit>, Integer, Hash)> backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts)
311
+
312
+ ```ruby
313
+ begin
314
+ # Partially modify a Backup Unit
315
+ data, status_code, headers = api_instance.backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts)
316
+ p status_code # => 2xx
317
+ p headers # => { ... }
318
+ p data # => <BackupUnit>
319
+ rescue Ionoscloud::ApiError => e
320
+ puts "Error when calling BackupUnitApi->backupunits_patch_with_http_info: #{e}"
321
+ end
322
+ ```
323
+
324
+ ### Parameters
325
+
326
+ | Name | Type | Description | Notes |
327
+ | ---- | ---- | ----------- | ----- |
328
+ | **backupunit_id** | **String** | The unique ID of the backup unit | |
329
+ | **backup_unit_properties** | [**BackupUnitProperties**](BackupUnitProperties.md) | Modified backup Unit properties | |
330
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
331
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
332
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
333
+
334
+ ### Return type
335
+
336
+ [**BackupUnit**](BackupUnit.md)
337
+
338
+ ### Authorization
339
+
340
+ Basic Authentication, Token Authentication
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: application/json
345
+ - **Accept**: application/json
346
+
347
+
348
+ ## backupunits_post
349
+
350
+ > <BackupUnit> backupunits_post(backup_unit, opts)
351
+
352
+ Create a Backup Unit
353
+
354
+ Create a Backup Unit. A Backup Unit is considered a resource like a virtual datacenter, IP Block, snapshot, etc. It shall be shareable via groups inside our User Management Feature
355
+
356
+ ### Examples
357
+
358
+ ```ruby
359
+ require 'time'
360
+ require 'ionoscloud'
361
+ # setup authorization
362
+ Ionoscloud.configure do |config|
363
+ # Configure HTTP basic authorization: Basic Authentication
364
+ config.username = 'YOUR USERNAME'
365
+ config.password = 'YOUR PASSWORD'
366
+
367
+ # Configure API key authorization: Token Authentication
368
+ config.api_key['Authorization'] = 'YOUR API KEY'
369
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
370
+ # config.api_key_prefix['Authorization'] = 'Bearer'
371
+ end
372
+
373
+ api_instance = Ionoscloud::BackupUnitApi.new
374
+ backup_unit = Ionoscloud::BackupUnit.new({properties: Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'})}) # BackupUnit | Payload containing data to create a new Backup Unit
375
+ opts = {
376
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
377
+ 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
378
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
379
+ }
380
+
381
+ begin
382
+ # Create a Backup Unit
383
+ result = api_instance.backupunits_post(backup_unit, opts)
384
+ p result
385
+ rescue Ionoscloud::ApiError => e
386
+ puts "Error when calling BackupUnitApi->backupunits_post: #{e}"
387
+ end
388
+ ```
389
+
390
+ #### Using the backupunits_post_with_http_info variant
391
+
392
+ This returns an Array which contains the response data, status code and headers.
393
+
394
+ > <Array(<BackupUnit>, Integer, Hash)> backupunits_post_with_http_info(backup_unit, opts)
395
+
396
+ ```ruby
397
+ begin
398
+ # Create a Backup Unit
399
+ data, status_code, headers = api_instance.backupunits_post_with_http_info(backup_unit, opts)
400
+ p status_code # => 2xx
401
+ p headers # => { ... }
402
+ p data # => <BackupUnit>
403
+ rescue Ionoscloud::ApiError => e
404
+ puts "Error when calling BackupUnitApi->backupunits_post_with_http_info: #{e}"
405
+ end
406
+ ```
407
+
408
+ ### Parameters
409
+
410
+ | Name | Type | Description | Notes |
411
+ | ---- | ---- | ----------- | ----- |
412
+ | **backup_unit** | [**BackupUnit**](BackupUnit.md) | Payload containing data to create a new Backup Unit | |
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&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... 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
+ [**BackupUnit**](BackupUnit.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
+
430
+
431
+ ## backupunits_put
432
+
433
+ > <BackupUnit> backupunits_put(backupunit_id, backup_unit, opts)
434
+
435
+ Modify a Backup Unit
436
+
437
+ You can use update a backup Unit properties
438
+
439
+ ### Examples
440
+
441
+ ```ruby
442
+ require 'time'
443
+ require 'ionoscloud'
444
+ # setup authorization
445
+ Ionoscloud.configure do |config|
446
+ # Configure HTTP basic authorization: Basic Authentication
447
+ config.username = 'YOUR USERNAME'
448
+ config.password = 'YOUR PASSWORD'
449
+
450
+ # Configure API key authorization: Token Authentication
451
+ config.api_key['Authorization'] = 'YOUR API KEY'
452
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
453
+ # config.api_key_prefix['Authorization'] = 'Bearer'
454
+ end
455
+
456
+ api_instance = Ionoscloud::BackupUnitApi.new
457
+ backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit
458
+ backup_unit = Ionoscloud::BackupUnit.new({properties: Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'})}) # BackupUnit | Modified backup Unit
459
+ opts = {
460
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
461
+ 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
462
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
463
+ }
464
+
465
+ begin
466
+ # Modify a Backup Unit
467
+ result = api_instance.backupunits_put(backupunit_id, backup_unit, opts)
468
+ p result
469
+ rescue Ionoscloud::ApiError => e
470
+ puts "Error when calling BackupUnitApi->backupunits_put: #{e}"
471
+ end
472
+ ```
473
+
474
+ #### Using the backupunits_put_with_http_info variant
475
+
476
+ This returns an Array which contains the response data, status code and headers.
477
+
478
+ > <Array(<BackupUnit>, Integer, Hash)> backupunits_put_with_http_info(backupunit_id, backup_unit, opts)
479
+
480
+ ```ruby
481
+ begin
482
+ # Modify a Backup Unit
483
+ data, status_code, headers = api_instance.backupunits_put_with_http_info(backupunit_id, backup_unit, opts)
484
+ p status_code # => 2xx
485
+ p headers # => { ... }
486
+ p data # => <BackupUnit>
487
+ rescue Ionoscloud::ApiError => e
488
+ puts "Error when calling BackupUnitApi->backupunits_put_with_http_info: #{e}"
489
+ end
490
+ ```
491
+
492
+ ### Parameters
493
+
494
+ | Name | Type | Description | Notes |
495
+ | ---- | ---- | ----------- | ----- |
496
+ | **backupunit_id** | **String** | The unique ID of the backup unit | |
497
+ | **backup_unit** | [**BackupUnit**](BackupUnit.md) | Modified backup Unit | |
498
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
499
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
500
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
501
+
502
+ ### Return type
503
+
504
+ [**BackupUnit**](BackupUnit.md)
505
+
506
+ ### Authorization
507
+
508
+ Basic Authentication, Token Authentication
509
+
510
+ ### HTTP request headers
511
+
512
+ - **Content-Type**: application/json
513
+ - **Accept**: application/json
514
+
515
+
516
+ ## backupunits_ssourl_get
517
+
518
+ > <BackupUnitSSO> backupunits_ssourl_get(backupunit_id, opts)
519
+
520
+ Returns a single signon URL for the specified backup Unit.
521
+
522
+ Returns a single signon URL for the specified backup Unit.
523
+
524
+ ### Examples
525
+
526
+ ```ruby
527
+ require 'time'
528
+ require 'ionoscloud'
529
+ # setup authorization
530
+ Ionoscloud.configure do |config|
531
+ # Configure HTTP basic authorization: Basic Authentication
532
+ config.username = 'YOUR USERNAME'
533
+ config.password = 'YOUR PASSWORD'
534
+
535
+ # Configure API key authorization: Token Authentication
536
+ config.api_key['Authorization'] = 'YOUR API KEY'
537
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
538
+ # config.api_key_prefix['Authorization'] = 'Bearer'
539
+ end
540
+
541
+ api_instance = Ionoscloud::BackupUnitApi.new
542
+ backupunit_id = 'backupunit_id_example' # String | The unique UUID of the backup unit
543
+ opts = {
544
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
545
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
546
+ }
547
+
548
+ begin
549
+ # Returns a single signon URL for the specified backup Unit.
550
+ result = api_instance.backupunits_ssourl_get(backupunit_id, opts)
551
+ p result
552
+ rescue Ionoscloud::ApiError => e
553
+ puts "Error when calling BackupUnitApi->backupunits_ssourl_get: #{e}"
554
+ end
555
+ ```
556
+
557
+ #### Using the backupunits_ssourl_get_with_http_info variant
558
+
559
+ This returns an Array which contains the response data, status code and headers.
560
+
561
+ > <Array(<BackupUnitSSO>, Integer, Hash)> backupunits_ssourl_get_with_http_info(backupunit_id, opts)
562
+
563
+ ```ruby
564
+ begin
565
+ # Returns a single signon URL for the specified backup Unit.
566
+ data, status_code, headers = api_instance.backupunits_ssourl_get_with_http_info(backupunit_id, opts)
567
+ p status_code # => 2xx
568
+ p headers # => { ... }
569
+ p data # => <BackupUnitSSO>
570
+ rescue Ionoscloud::ApiError => e
571
+ puts "Error when calling BackupUnitApi->backupunits_ssourl_get_with_http_info: #{e}"
572
+ end
573
+ ```
574
+
575
+ ### Parameters
576
+
577
+ | Name | Type | Description | Notes |
578
+ | ---- | ---- | ----------- | ----- |
579
+ | **backupunit_id** | **String** | The unique UUID of the backup unit | |
580
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
581
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
582
+
583
+ ### Return type
584
+
585
+ [**BackupUnitSSO**](BackupUnitSSO.md)
586
+
587
+ ### Authorization
588
+
589
+ Basic Authentication, Token Authentication
590
+
591
+ ### HTTP request headers
592
+
593
+ - **Content-Type**: Not defined
594
+ - **Accept**: application/json
595
+