ionoscloud 5.0.0 → 6.0.0.beta.3

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 (594) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AttachedVolumes.md +30 -0
  4. data/docs/BackupUnit.md +26 -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/BackupUnitsApi.md +594 -0
  9. data/docs/BalancedNics.md +30 -0
  10. data/docs/CHANGELOG.md +1 -0
  11. data/docs/Cdroms.md +30 -0
  12. data/docs/ConnectableDatacenter.md +22 -0
  13. data/docs/Contract.md +20 -0
  14. data/docs/ContractProperties.md +26 -0
  15. data/docs/ContractResourcesApi.md +89 -0
  16. data/docs/Contracts.md +24 -0
  17. data/docs/CpuArchitectureProperties.md +24 -0
  18. data/docs/DataCenterEntities.md +28 -0
  19. data/docs/DataCentersApi.md +516 -0
  20. data/docs/Datacenter.md +28 -0
  21. data/docs/DatacenterElementMetadata.md +32 -0
  22. data/docs/DatacenterProperties.md +30 -0
  23. data/docs/Datacenters.md +30 -0
  24. data/docs/DefaultApi.md +78 -0
  25. data/docs/Error.md +20 -0
  26. data/docs/ErrorMessage.md +20 -0
  27. data/docs/FirewallRule.md +26 -0
  28. data/docs/FirewallRules.md +30 -0
  29. data/docs/FirewallRulesApi.md +552 -0
  30. data/docs/FirewallruleProperties.md +36 -0
  31. data/docs/FlowLog.md +26 -0
  32. data/docs/FlowLogProperties.md +24 -0
  33. data/docs/FlowLogPut.md +24 -0
  34. data/docs/FlowLogs.md +30 -0
  35. data/docs/FlowLogsApi.md +540 -0
  36. data/docs/Group.md +26 -0
  37. data/docs/GroupEntities.md +20 -0
  38. data/docs/GroupMembers.md +24 -0
  39. data/docs/GroupProperties.md +42 -0
  40. data/docs/GroupShare.md +24 -0
  41. data/docs/GroupShareProperties.md +20 -0
  42. data/docs/GroupShares.md +24 -0
  43. data/docs/GroupUsers.md +24 -0
  44. data/docs/Groups.md +24 -0
  45. data/docs/IPBlocksApi.md +512 -0
  46. data/docs/IPFailover.md +20 -0
  47. data/docs/Image.md +26 -0
  48. data/docs/ImageProperties.md +54 -0
  49. data/docs/Images.md +24 -0
  50. data/docs/ImagesApi.md +428 -0
  51. data/docs/Info.md +22 -0
  52. data/docs/IpBlock.md +26 -0
  53. data/docs/IpBlockProperties.md +26 -0
  54. data/docs/IpBlocks.md +24 -0
  55. data/docs/IpConsumer.md +34 -0
  56. data/docs/KubernetesApi.md +1433 -0
  57. data/docs/KubernetesAutoScaling.md +20 -0
  58. data/docs/KubernetesCluster.md +28 -0
  59. data/docs/KubernetesClusterEntities.md +18 -0
  60. data/docs/KubernetesClusterForPost.md +28 -0
  61. data/docs/KubernetesClusterForPut.md +28 -0
  62. data/docs/KubernetesClusterProperties.md +30 -0
  63. data/docs/KubernetesClusterPropertiesForPost.md +26 -0
  64. data/docs/KubernetesClusterPropertiesForPut.md +22 -0
  65. data/docs/KubernetesClusters.md +24 -0
  66. data/docs/KubernetesMaintenanceWindow.md +20 -0
  67. data/docs/KubernetesNode.md +26 -0
  68. data/docs/KubernetesNodeMetadata.md +26 -0
  69. data/docs/KubernetesNodePool.md +26 -0
  70. data/docs/KubernetesNodePoolForPost.md +26 -0
  71. data/docs/KubernetesNodePoolForPut.md +26 -0
  72. data/docs/KubernetesNodePoolLan.md +22 -0
  73. data/docs/KubernetesNodePoolLanRoutes.md +20 -0
  74. data/docs/KubernetesNodePoolProperties.md +50 -0
  75. data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
  76. data/docs/KubernetesNodePoolPropertiesForPut.md +34 -0
  77. data/docs/KubernetesNodePools.md +24 -0
  78. data/docs/KubernetesNodeProperties.md +24 -0
  79. data/docs/KubernetesNodes.md +24 -0
  80. data/docs/Label.md +26 -0
  81. data/docs/LabelProperties.md +26 -0
  82. data/docs/LabelResource.md +26 -0
  83. data/docs/LabelResourceProperties.md +20 -0
  84. data/docs/LabelResources.md +30 -0
  85. data/docs/Labels.md +24 -0
  86. data/docs/LabelsApi.md +2346 -0
  87. data/docs/Lan.md +28 -0
  88. data/docs/LanEntities.md +18 -0
  89. data/docs/LanNics.md +30 -0
  90. data/docs/LanPost.md +28 -0
  91. data/docs/LanProperties.md +24 -0
  92. data/docs/LanPropertiesPost.md +24 -0
  93. data/docs/Lans.md +30 -0
  94. data/docs/LansApi.md +794 -0
  95. data/docs/LoadBalancersApi.md +885 -0
  96. data/docs/Loadbalancer.md +28 -0
  97. data/docs/LoadbalancerEntities.md +18 -0
  98. data/docs/LoadbalancerProperties.md +22 -0
  99. data/docs/Loadbalancers.md +30 -0
  100. data/docs/Location.md +26 -0
  101. data/docs/LocationProperties.md +24 -0
  102. data/docs/Locations.md +24 -0
  103. data/docs/LocationsApi.md +259 -0
  104. data/docs/NATGatewaysApi.md +1578 -0
  105. data/docs/NatGateway.md +28 -0
  106. data/docs/NatGatewayEntities.md +20 -0
  107. data/docs/NatGatewayLanProperties.md +20 -0
  108. data/docs/NatGatewayProperties.md +22 -0
  109. data/docs/NatGatewayPut.md +24 -0
  110. data/docs/NatGatewayRule.md +26 -0
  111. data/docs/NatGatewayRuleProperties.md +30 -0
  112. data/docs/NatGatewayRuleProtocol.md +15 -0
  113. data/docs/NatGatewayRulePut.md +24 -0
  114. data/docs/NatGatewayRuleType.md +15 -0
  115. data/docs/NatGatewayRules.md +24 -0
  116. data/docs/NatGateways.md +30 -0
  117. data/docs/NetworkInterfacesApi.md +540 -0
  118. data/docs/NetworkLoadBalancer.md +28 -0
  119. data/docs/NetworkLoadBalancerEntities.md +20 -0
  120. data/docs/NetworkLoadBalancerForwardingRule.md +26 -0
  121. data/docs/NetworkLoadBalancerForwardingRuleHealthCheck.md +26 -0
  122. data/docs/NetworkLoadBalancerForwardingRuleProperties.md +30 -0
  123. data/docs/NetworkLoadBalancerForwardingRulePut.md +24 -0
  124. data/docs/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
  125. data/docs/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
  126. data/docs/NetworkLoadBalancerForwardingRules.md +30 -0
  127. data/docs/NetworkLoadBalancerProperties.md +26 -0
  128. data/docs/NetworkLoadBalancerPut.md +24 -0
  129. data/docs/NetworkLoadBalancers.md +30 -0
  130. data/docs/NetworkLoadBalancersApi.md +1590 -0
  131. data/docs/Nic.md +28 -0
  132. data/docs/NicEntities.md +20 -0
  133. data/docs/NicProperties.md +34 -0
  134. data/docs/NicPut.md +24 -0
  135. data/docs/Nics.md +30 -0
  136. data/docs/NoStateMetaData.md +30 -0
  137. data/docs/PaginationLinks.md +22 -0
  138. data/docs/Peer.md +26 -0
  139. data/docs/PrivateCrossConnect.md +26 -0
  140. data/docs/PrivateCrossConnectProperties.md +24 -0
  141. data/docs/PrivateCrossConnects.md +24 -0
  142. data/docs/PrivateCrossConnectsApi.md +430 -0
  143. data/docs/README.md +111 -0
  144. data/docs/RemoteConsoleUrl.md +18 -0
  145. data/docs/Request.md +26 -0
  146. data/docs/RequestMetadata.md +24 -0
  147. data/docs/RequestProperties.md +24 -0
  148. data/docs/RequestStatus.md +24 -0
  149. data/docs/RequestStatusMetadata.md +24 -0
  150. data/docs/RequestTarget.md +20 -0
  151. data/docs/Requests.md +30 -0
  152. data/docs/RequestsApi.md +283 -0
  153. data/docs/Resource.md +28 -0
  154. data/docs/ResourceEntities.md +18 -0
  155. data/docs/ResourceGroups.md +24 -0
  156. data/docs/ResourceLimits.md +60 -0
  157. data/docs/ResourceProperties.md +20 -0
  158. data/docs/ResourceReference.md +22 -0
  159. data/docs/Resources.md +24 -0
  160. data/docs/ResourcesUsers.md +24 -0
  161. data/docs/S3Key.md +26 -0
  162. data/docs/S3KeyMetadata.md +20 -0
  163. data/docs/S3KeyProperties.md +20 -0
  164. data/docs/S3Keys.md +24 -0
  165. data/docs/S3ObjectStorageSSO.md +18 -0
  166. data/docs/Server.md +28 -0
  167. data/docs/ServerEntities.md +22 -0
  168. data/docs/ServerProperties.md +36 -0
  169. data/docs/Servers.md +30 -0
  170. data/docs/ServersApi.md +1908 -0
  171. data/docs/Snapshot.md +26 -0
  172. data/docs/SnapshotProperties.md +48 -0
  173. data/docs/Snapshots.md +24 -0
  174. data/docs/SnapshotsApi.md +428 -0
  175. data/docs/TargetPortRange.md +20 -0
  176. data/docs/Template.md +26 -0
  177. data/docs/TemplateProperties.md +24 -0
  178. data/docs/Templates.md +24 -0
  179. data/docs/TemplatesApi.md +165 -0
  180. data/docs/Token.md +18 -0
  181. data/docs/Type.md +15 -0
  182. data/docs/User.md +28 -0
  183. data/docs/UserManagementApi.md +2033 -0
  184. data/docs/UserMetadata.md +22 -0
  185. data/docs/UserPost.md +18 -0
  186. data/docs/UserProperties.md +32 -0
  187. data/docs/UserPropertiesPost.md +32 -0
  188. data/docs/UserPropertiesPut.md +30 -0
  189. data/docs/UserPut.md +20 -0
  190. data/docs/UserS3KeysApi.md +516 -0
  191. data/docs/Users.md +24 -0
  192. data/docs/UsersEntities.md +20 -0
  193. data/docs/Volume.md +26 -0
  194. data/docs/VolumeProperties.md +54 -0
  195. data/docs/Volumes.md +30 -0
  196. data/docs/VolumesApi.md +709 -0
  197. data/docs/summary.md +395 -0
  198. data/gitbook.yaml +4 -0
  199. data/ionoscloud.gemspec +1 -1
  200. data/lib/ionoscloud.rb +68 -18
  201. data/lib/ionoscloud/api/_api.rb +1 -1
  202. data/lib/ionoscloud/api/{backup_unit_api.rb → backup_units_api.rb} +60 -60
  203. data/lib/ionoscloud/api/{contract_api.rb → contract_resources_api.rb} +12 -12
  204. data/lib/ionoscloud/api/{data_center_api.rb → data_centers_api.rb} +51 -51
  205. data/lib/ionoscloud/api/firewall_rules_api.rb +640 -0
  206. data/lib/ionoscloud/api/flow_logs_api.rb +622 -0
  207. data/lib/ionoscloud/api/{image_api.rb → images_api.rb} +40 -40
  208. data/lib/ionoscloud/api/ip_blocks_api.rb +16 -16
  209. data/lib/ionoscloud/api/kubernetes_api.rb +33 -96
  210. data/lib/ionoscloud/api/{label_api.rb → labels_api.rb} +269 -287
  211. data/lib/ionoscloud/api/{lan_api.rb → lans_api.rb} +105 -105
  212. data/lib/ionoscloud/api/{load_balancer_api.rb → load_balancers_api.rb} +153 -135
  213. data/lib/ionoscloud/api/{location_api.rb → locations_api.rb} +20 -20
  214. data/lib/ionoscloud/api/nat_gateways_api.rb +1690 -0
  215. data/lib/ionoscloud/api/network_interfaces_api.rb +604 -0
  216. data/lib/ionoscloud/api/network_load_balancers_api.rb +1708 -0
  217. data/lib/ionoscloud/api/{private_cross_connect_api.rb → private_cross_connects_api.rb} +61 -43
  218. data/lib/ionoscloud/api/{request_api.rb → requests_api.rb} +56 -32
  219. data/lib/ionoscloud/api/{server_api.rb → servers_api.rb} +535 -191
  220. data/lib/ionoscloud/api/{snapshot_api.rb → snapshots_api.rb} +46 -46
  221. data/lib/ionoscloud/api/templates_api.rb +164 -0
  222. data/lib/ionoscloud/api/user_management_api.rb +29 -524
  223. data/lib/ionoscloud/api/user_s3_keys_api.rb +517 -0
  224. data/lib/ionoscloud/api/{volume_api.rb → volumes_api.rb} +80 -80
  225. data/lib/ionoscloud/api_client.rb +19 -23
  226. data/lib/ionoscloud/api_error.rb +1 -1
  227. data/lib/ionoscloud/configuration.rb +5 -5
  228. data/lib/ionoscloud/models/attached_volumes.rb +1 -1
  229. data/lib/ionoscloud/models/backup_unit.rb +1 -1
  230. data/lib/ionoscloud/models/backup_unit_properties.rb +1 -1
  231. data/lib/ionoscloud/models/backup_unit_sso.rb +1 -1
  232. data/lib/ionoscloud/models/backup_units.rb +3 -3
  233. data/lib/ionoscloud/models/balanced_nics.rb +1 -1
  234. data/lib/ionoscloud/models/cdroms.rb +1 -1
  235. data/lib/ionoscloud/models/connectable_datacenter.rb +1 -1
  236. data/lib/ionoscloud/models/contract.rb +1 -1
  237. data/lib/ionoscloud/models/contract_properties.rb +1 -1
  238. data/lib/ionoscloud/models/contracts.rb +249 -0
  239. data/lib/ionoscloud/models/cpu_architecture_properties.rb +247 -0
  240. data/lib/ionoscloud/models/data_center_entities.rb +23 -5
  241. data/lib/ionoscloud/models/datacenter.rb +1 -1
  242. data/lib/ionoscloud/models/datacenter_element_metadata.rb +1 -1
  243. data/lib/ionoscloud/models/datacenter_properties.rb +16 -26
  244. data/lib/ionoscloud/models/datacenters.rb +1 -1
  245. data/lib/ionoscloud/models/error.rb +1 -1
  246. data/lib/ionoscloud/models/error_message.rb +1 -1
  247. data/lib/ionoscloud/models/firewall_rule.rb +1 -1
  248. data/lib/ionoscloud/models/firewall_rules.rb +1 -1
  249. data/lib/ionoscloud/models/firewallrule_properties.rb +63 -26
  250. data/lib/ionoscloud/models/flow_log.rb +260 -0
  251. data/lib/ionoscloud/models/flow_log_properties.rb +313 -0
  252. data/lib/ionoscloud/models/flow_log_put.rb +251 -0
  253. data/lib/ionoscloud/models/flow_logs.rb +278 -0
  254. data/lib/ionoscloud/models/group.rb +1 -1
  255. data/lib/ionoscloud/models/group_entities.rb +1 -1
  256. data/lib/ionoscloud/models/group_members.rb +1 -1
  257. data/lib/ionoscloud/models/group_properties.rb +35 -5
  258. data/lib/ionoscloud/models/group_share.rb +1 -1
  259. data/lib/ionoscloud/models/group_share_properties.rb +1 -1
  260. data/lib/ionoscloud/models/group_shares.rb +1 -1
  261. data/lib/ionoscloud/models/group_users.rb +1 -1
  262. data/lib/ionoscloud/models/groups.rb +1 -1
  263. data/lib/ionoscloud/models/image.rb +1 -1
  264. data/lib/ionoscloud/models/image_properties.rb +39 -5
  265. data/lib/ionoscloud/models/images.rb +1 -1
  266. data/lib/ionoscloud/models/info.rb +1 -1
  267. data/lib/ionoscloud/models/ip_block.rb +1 -1
  268. data/lib/ionoscloud/models/ip_block_properties.rb +1 -1
  269. data/lib/ionoscloud/models/ip_blocks.rb +1 -1
  270. data/lib/ionoscloud/models/ip_consumer.rb +23 -5
  271. data/lib/ionoscloud/models/ip_failover.rb +1 -1
  272. data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +11 -1
  273. data/lib/ionoscloud/models/kubernetes_cluster.rb +1 -1
  274. data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +1 -1
  275. data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +303 -0
  276. data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +303 -0
  277. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +27 -5
  278. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +263 -0
  279. data/lib/ionoscloud/models/{kubernetes_cluster_properties_for_post_and_put.rb → kubernetes_cluster_properties_for_put.rb} +5 -5
  280. data/lib/ionoscloud/models/kubernetes_clusters.rb +2 -2
  281. data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +11 -1
  282. data/lib/ionoscloud/models/kubernetes_node.rb +3 -3
  283. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +1 -1
  284. data/lib/ionoscloud/models/kubernetes_node_pool.rb +1 -1
  285. data/lib/ionoscloud/models/{kubernetes_config.rb → kubernetes_node_pool_for_post.rb} +17 -8
  286. data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +1 -1
  287. data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +27 -5
  288. data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +227 -0
  289. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +2 -2
  290. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +2 -2
  291. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +2 -153
  292. data/lib/ionoscloud/models/kubernetes_node_pools.rb +2 -2
  293. data/lib/ionoscloud/models/kubernetes_node_properties.rb +12 -7
  294. data/lib/ionoscloud/models/kubernetes_nodes.rb +3 -3
  295. data/lib/ionoscloud/models/label.rb +1 -1
  296. data/lib/ionoscloud/models/label_properties.rb +1 -1
  297. data/lib/ionoscloud/models/label_resource.rb +1 -1
  298. data/lib/ionoscloud/models/label_resource_properties.rb +1 -1
  299. data/lib/ionoscloud/models/label_resources.rb +3 -3
  300. data/lib/ionoscloud/models/labels.rb +3 -3
  301. data/lib/ionoscloud/models/lan.rb +1 -1
  302. data/lib/ionoscloud/models/lan_entities.rb +1 -1
  303. data/lib/ionoscloud/models/lan_nics.rb +1 -1
  304. data/lib/ionoscloud/models/lan_post.rb +1 -1
  305. data/lib/ionoscloud/models/lan_properties.rb +1 -1
  306. data/lib/ionoscloud/models/lan_properties_post.rb +1 -1
  307. data/lib/ionoscloud/models/lans.rb +2 -2
  308. data/lib/ionoscloud/models/loadbalancer.rb +1 -1
  309. data/lib/ionoscloud/models/loadbalancer_entities.rb +1 -1
  310. data/lib/ionoscloud/models/loadbalancer_properties.rb +13 -30
  311. data/lib/ionoscloud/models/loadbalancers.rb +1 -1
  312. data/lib/ionoscloud/models/location.rb +1 -1
  313. data/lib/ionoscloud/models/location_properties.rb +16 -26
  314. data/lib/ionoscloud/models/locations.rb +1 -1
  315. data/lib/ionoscloud/models/nat_gateway.rb +269 -0
  316. data/lib/ionoscloud/models/nat_gateway_entities.rb +225 -0
  317. data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +234 -0
  318. data/lib/ionoscloud/models/nat_gateway_properties.rb +251 -0
  319. data/lib/ionoscloud/models/nat_gateway_put.rb +251 -0
  320. data/lib/ionoscloud/models/nat_gateway_rule.rb +260 -0
  321. data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +291 -0
  322. data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +39 -0
  323. data/lib/ionoscloud/models/nat_gateway_rule_put.rb +251 -0
  324. data/lib/ionoscloud/models/nat_gateway_rule_type.rb +36 -0
  325. data/lib/ionoscloud/models/nat_gateway_rules.rb +249 -0
  326. data/lib/ionoscloud/models/nat_gateways.rb +278 -0
  327. data/lib/ionoscloud/models/network_load_balancer.rb +269 -0
  328. data/lib/ionoscloud/models/network_load_balancer_entities.rb +225 -0
  329. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +260 -0
  330. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +257 -0
  331. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +354 -0
  332. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +251 -0
  333. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +261 -0
  334. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +237 -0
  335. data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +278 -0
  336. data/lib/ionoscloud/models/network_load_balancer_properties.rb +276 -0
  337. data/lib/ionoscloud/models/network_load_balancer_put.rb +251 -0
  338. data/lib/ionoscloud/models/network_load_balancers.rb +278 -0
  339. data/lib/ionoscloud/models/nic.rb +1 -1
  340. data/lib/ionoscloud/models/nic_entities.rb +11 -2
  341. data/lib/ionoscloud/models/nic_properties.rb +63 -9
  342. data/lib/ionoscloud/models/nic_put.rb +251 -0
  343. data/lib/ionoscloud/models/nics.rb +1 -1
  344. data/lib/ionoscloud/models/no_state_meta_data.rb +1 -1
  345. data/lib/ionoscloud/models/pagination_links.rb +1 -1
  346. data/lib/ionoscloud/models/peer.rb +1 -1
  347. data/lib/ionoscloud/models/private_cross_connect.rb +1 -1
  348. data/lib/ionoscloud/models/private_cross_connect_properties.rb +1 -1
  349. data/lib/ionoscloud/models/private_cross_connects.rb +1 -1
  350. data/lib/ionoscloud/models/{kubernetes_config_properties.rb → remote_console_url.rb} +12 -12
  351. data/lib/ionoscloud/models/request.rb +1 -1
  352. data/lib/ionoscloud/models/request_metadata.rb +1 -1
  353. data/lib/ionoscloud/models/request_properties.rb +1 -1
  354. data/lib/ionoscloud/models/request_status.rb +1 -1
  355. data/lib/ionoscloud/models/request_status_metadata.rb +1 -1
  356. data/lib/ionoscloud/models/request_target.rb +1 -1
  357. data/lib/ionoscloud/models/requests.rb +1 -1
  358. data/lib/ionoscloud/models/resource.rb +1 -1
  359. data/lib/ionoscloud/models/resource_entities.rb +1 -1
  360. data/lib/ionoscloud/models/resource_groups.rb +1 -1
  361. data/lib/ionoscloud/models/resource_limits.rb +80 -5
  362. data/lib/ionoscloud/models/resource_properties.rb +1 -1
  363. data/lib/ionoscloud/models/resource_reference.rb +1 -1
  364. data/lib/ionoscloud/models/resources.rb +1 -1
  365. data/lib/ionoscloud/models/resources_users.rb +1 -1
  366. data/lib/ionoscloud/models/s3_key.rb +1 -1
  367. data/lib/ionoscloud/models/s3_key_metadata.rb +1 -1
  368. data/lib/ionoscloud/models/s3_key_properties.rb +3 -3
  369. data/lib/ionoscloud/models/s3_keys.rb +1 -1
  370. data/lib/ionoscloud/models/s3_object_storage_sso.rb +1 -1
  371. data/lib/ionoscloud/models/server.rb +1 -1
  372. data/lib/ionoscloud/models/server_entities.rb +1 -1
  373. data/lib/ionoscloud/models/server_properties.rb +28 -8
  374. data/lib/ionoscloud/models/servers.rb +1 -1
  375. data/lib/ionoscloud/models/snapshot.rb +1 -1
  376. data/lib/ionoscloud/models/snapshot_properties.rb +1 -1
  377. data/lib/ionoscloud/models/snapshots.rb +1 -1
  378. data/lib/ionoscloud/models/target_port_range.rb +227 -0
  379. data/lib/ionoscloud/models/template.rb +260 -0
  380. data/lib/ionoscloud/models/template_properties.rb +267 -0
  381. data/lib/ionoscloud/models/templates.rb +249 -0
  382. data/lib/ionoscloud/models/token.rb +217 -0
  383. data/lib/ionoscloud/models/type.rb +10 -1
  384. data/lib/ionoscloud/models/user.rb +1 -1
  385. data/lib/ionoscloud/models/user_metadata.rb +1 -1
  386. data/lib/ionoscloud/models/user_post.rb +221 -0
  387. data/lib/ionoscloud/models/user_properties.rb +2 -12
  388. data/lib/ionoscloud/models/user_properties_post.rb +287 -0
  389. data/lib/ionoscloud/models/user_properties_put.rb +277 -0
  390. data/lib/ionoscloud/models/user_put.rb +231 -0
  391. data/lib/ionoscloud/models/users.rb +1 -1
  392. data/lib/ionoscloud/models/users_entities.rb +1 -1
  393. data/lib/ionoscloud/models/volume.rb +1 -1
  394. data/lib/ionoscloud/models/volume_properties.rb +31 -20
  395. data/lib/ionoscloud/models/volumes.rb +1 -1
  396. data/lib/ionoscloud/version.rb +2 -2
  397. data/spec/api/_api_spec.rb +1 -1
  398. data/spec/api/{backup_unit_api_spec.rb → backup_units_api_spec.rb} +14 -14
  399. data/spec/api/{contract_api_spec.rb → contract_resources_api_spec.rb} +9 -9
  400. data/spec/api/{data_center_api_spec.rb → data_centers_api_spec.rb} +10 -10
  401. data/spec/api/firewall_rules_api_spec.rb +146 -0
  402. data/spec/api/flow_logs_api_spec.rb +140 -0
  403. data/spec/api/{image_api_spec.rb → images_api_spec.rb} +9 -9
  404. data/spec/api/ip_blocks_api_spec.rb +7 -7
  405. data/spec/api/kubernetes_api_spec.rb +10 -22
  406. data/spec/api/{label_api_spec.rb → labels_api_spec.rb} +21 -23
  407. data/spec/api/{lan_api_spec.rb → lans_api_spec.rb} +21 -21
  408. data/spec/api/{load_balancer_api_spec.rb → load_balancers_api_spec.rb} +27 -25
  409. data/spec/api/{location_api_spec.rb → locations_api_spec.rb} +7 -7
  410. data/spec/api/{nic_api_spec.rb → nat_gateways_api_spec.rb} +188 -103
  411. data/spec/api/network_interfaces_api_spec.rb +140 -0
  412. data/spec/api/network_load_balancers_api_spec.rb +342 -0
  413. data/spec/api/{private_cross_connect_api_spec.rb → private_cross_connects_api_spec.rb} +13 -11
  414. data/spec/api/{request_api_spec.rb → requests_api_spec.rb} +20 -12
  415. data/spec/api/{server_api_spec.rb → servers_api_spec.rb} +84 -20
  416. data/spec/api/{snapshot_api_spec.rb → snapshots_api_spec.rb} +12 -12
  417. data/spec/api/templates_api_spec.rb +60 -0
  418. data/spec/api/user_management_api_spec.rb +7 -100
  419. data/spec/api/user_s3_keys_api_spec.rb +128 -0
  420. data/spec/api/{volume_api_spec.rb → volumes_api_spec.rb} +13 -13
  421. data/spec/api_client_spec.rb +1 -1
  422. data/spec/configuration_spec.rb +4 -4
  423. data/spec/models/attached_volumes_spec.rb +1 -1
  424. data/spec/models/backup_unit_properties_spec.rb +1 -1
  425. data/spec/models/backup_unit_spec.rb +1 -1
  426. data/spec/models/backup_unit_sso_spec.rb +1 -1
  427. data/spec/models/backup_units_spec.rb +2 -2
  428. data/spec/models/balanced_nics_spec.rb +1 -1
  429. data/spec/models/cdroms_spec.rb +1 -1
  430. data/spec/models/connectable_datacenter_spec.rb +1 -1
  431. data/spec/models/contract_properties_spec.rb +1 -1
  432. data/spec/models/contract_spec.rb +1 -1
  433. data/spec/models/contracts_spec.rb +52 -0
  434. data/spec/models/cpu_architecture_properties_spec.rb +52 -0
  435. data/spec/models/data_center_entities_spec.rb +13 -1
  436. data/spec/models/datacenter_element_metadata_spec.rb +1 -1
  437. data/spec/models/datacenter_properties_spec.rb +7 -5
  438. data/spec/models/datacenter_spec.rb +1 -1
  439. data/spec/models/datacenters_spec.rb +1 -1
  440. data/spec/models/error_message_spec.rb +1 -1
  441. data/spec/models/error_spec.rb +1 -1
  442. data/spec/models/firewall_rule_spec.rb +1 -1
  443. data/spec/models/firewall_rules_spec.rb +1 -1
  444. data/spec/models/firewallrule_properties_spec.rb +11 -13
  445. data/spec/models/flow_log_properties_spec.rb +60 -0
  446. data/spec/models/flow_log_put_spec.rb +52 -0
  447. data/spec/models/flow_log_spec.rb +58 -0
  448. data/spec/models/flow_logs_spec.rb +70 -0
  449. data/spec/models/group_entities_spec.rb +1 -1
  450. data/spec/models/group_members_spec.rb +1 -1
  451. data/spec/models/group_properties_spec.rb +19 -1
  452. data/spec/models/group_share_properties_spec.rb +1 -1
  453. data/spec/models/group_share_spec.rb +1 -1
  454. data/spec/models/group_shares_spec.rb +1 -1
  455. data/spec/models/group_spec.rb +1 -1
  456. data/spec/models/group_users_spec.rb +1 -1
  457. data/spec/models/groups_spec.rb +1 -1
  458. data/spec/models/image_properties_spec.rb +17 -1
  459. data/spec/models/image_spec.rb +1 -1
  460. data/spec/models/images_spec.rb +1 -1
  461. data/spec/models/info_spec.rb +1 -1
  462. data/spec/models/ip_block_properties_spec.rb +1 -1
  463. data/spec/models/ip_block_spec.rb +1 -1
  464. data/spec/models/ip_blocks_spec.rb +1 -1
  465. data/spec/models/ip_consumer_spec.rb +13 -1
  466. data/spec/models/ip_failover_spec.rb +1 -1
  467. data/spec/models/kubernetes_auto_scaling_spec.rb +1 -1
  468. data/spec/models/kubernetes_cluster_entities_spec.rb +1 -1
  469. data/spec/models/kubernetes_cluster_for_post_spec.rb +68 -0
  470. data/spec/models/kubernetes_cluster_for_put_spec.rb +68 -0
  471. data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +58 -0
  472. data/spec/models/{kubernetes_cluster_properties_for_post_and_put_spec.rb → kubernetes_cluster_properties_for_put_spec.rb} +7 -7
  473. data/spec/models/kubernetes_cluster_properties_spec.rb +13 -1
  474. data/spec/models/kubernetes_cluster_spec.rb +1 -1
  475. data/spec/models/kubernetes_clusters_spec.rb +1 -1
  476. data/spec/models/kubernetes_maintenance_window_spec.rb +1 -1
  477. data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
  478. data/spec/models/{kubernetes_config_spec.rb → kubernetes_node_pool_for_post_spec.rb} +14 -8
  479. data/spec/models/kubernetes_node_pool_for_put_spec.rb +1 -1
  480. data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +40 -0
  481. data/spec/models/kubernetes_node_pool_lan_spec.rb +13 -1
  482. data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +1 -1
  483. data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +1 -51
  484. data/spec/models/kubernetes_node_pool_properties_spec.rb +1 -1
  485. data/spec/models/kubernetes_node_pool_spec.rb +1 -1
  486. data/spec/models/kubernetes_node_pools_spec.rb +1 -1
  487. data/spec/models/kubernetes_node_properties_spec.rb +7 -1
  488. data/spec/models/kubernetes_node_spec.rb +2 -2
  489. data/spec/models/kubernetes_nodes_spec.rb +2 -2
  490. data/spec/models/label_properties_spec.rb +1 -1
  491. data/spec/models/label_resource_properties_spec.rb +1 -1
  492. data/spec/models/label_resource_spec.rb +1 -1
  493. data/spec/models/label_resources_spec.rb +2 -2
  494. data/spec/models/label_spec.rb +1 -1
  495. data/spec/models/labels_spec.rb +2 -2
  496. data/spec/models/lan_entities_spec.rb +1 -1
  497. data/spec/models/lan_nics_spec.rb +1 -1
  498. data/spec/models/lan_post_spec.rb +1 -1
  499. data/spec/models/lan_properties_post_spec.rb +1 -1
  500. data/spec/models/lan_properties_spec.rb +1 -1
  501. data/spec/models/lan_spec.rb +1 -1
  502. data/spec/models/lans_spec.rb +1 -1
  503. data/spec/models/loadbalancer_entities_spec.rb +1 -1
  504. data/spec/models/loadbalancer_properties_spec.rb +1 -5
  505. data/spec/models/loadbalancer_spec.rb +1 -1
  506. data/spec/models/loadbalancers_spec.rb +1 -1
  507. data/spec/models/location_properties_spec.rb +7 -5
  508. data/spec/models/location_spec.rb +1 -1
  509. data/spec/models/locations_spec.rb +1 -1
  510. data/spec/models/nat_gateway_entities_spec.rb +40 -0
  511. data/spec/models/nat_gateway_lan_properties_spec.rb +40 -0
  512. data/spec/models/nat_gateway_properties_spec.rb +46 -0
  513. data/spec/models/nat_gateway_put_spec.rb +52 -0
  514. data/spec/models/nat_gateway_rule_properties_spec.rb +70 -0
  515. data/spec/models/nat_gateway_rule_protocol_spec.rb +28 -0
  516. data/spec/models/nat_gateway_rule_put_spec.rb +52 -0
  517. data/spec/models/nat_gateway_rule_spec.rb +58 -0
  518. data/spec/models/nat_gateway_rule_type_spec.rb +28 -0
  519. data/spec/models/nat_gateway_rules_spec.rb +52 -0
  520. data/spec/models/nat_gateway_spec.rb +64 -0
  521. data/spec/models/nat_gateways_spec.rb +70 -0
  522. data/spec/models/network_load_balancer_entities_spec.rb +40 -0
  523. data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +58 -0
  524. data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +78 -0
  525. data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +52 -0
  526. data/spec/models/network_load_balancer_forwarding_rule_spec.rb +58 -0
  527. data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +46 -0
  528. data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +52 -0
  529. data/spec/models/network_load_balancer_forwarding_rules_spec.rb +70 -0
  530. data/spec/models/network_load_balancer_properties_spec.rb +58 -0
  531. data/spec/models/network_load_balancer_put_spec.rb +52 -0
  532. data/spec/models/network_load_balancer_spec.rb +64 -0
  533. data/spec/models/network_load_balancers_spec.rb +70 -0
  534. data/spec/models/nic_entities_spec.rb +7 -1
  535. data/spec/models/nic_properties_spec.rb +18 -2
  536. data/spec/models/nic_put_spec.rb +52 -0
  537. data/spec/models/nic_spec.rb +1 -1
  538. data/spec/models/nics_spec.rb +1 -1
  539. data/spec/models/no_state_meta_data_spec.rb +1 -1
  540. data/spec/models/pagination_links_spec.rb +1 -1
  541. data/spec/models/peer_spec.rb +1 -1
  542. data/spec/models/private_cross_connect_properties_spec.rb +1 -1
  543. data/spec/models/private_cross_connect_spec.rb +1 -1
  544. data/spec/models/private_cross_connects_spec.rb +1 -1
  545. data/spec/models/{kubernetes_config_properties_spec.rb → remote_console_url_spec.rb} +8 -8
  546. data/spec/models/request_metadata_spec.rb +1 -1
  547. data/spec/models/request_properties_spec.rb +1 -1
  548. data/spec/models/request_spec.rb +1 -1
  549. data/spec/models/request_status_metadata_spec.rb +1 -1
  550. data/spec/models/request_status_spec.rb +1 -1
  551. data/spec/models/request_target_spec.rb +1 -1
  552. data/spec/models/requests_spec.rb +1 -1
  553. data/spec/models/resource_entities_spec.rb +1 -1
  554. data/spec/models/resource_groups_spec.rb +1 -1
  555. data/spec/models/resource_limits_spec.rb +31 -1
  556. data/spec/models/resource_properties_spec.rb +1 -1
  557. data/spec/models/resource_reference_spec.rb +1 -1
  558. data/spec/models/resource_spec.rb +1 -1
  559. data/spec/models/resources_spec.rb +1 -1
  560. data/spec/models/resources_users_spec.rb +1 -1
  561. data/spec/models/s3_key_metadata_spec.rb +1 -1
  562. data/spec/models/s3_key_properties_spec.rb +1 -1
  563. data/spec/models/s3_key_spec.rb +1 -1
  564. data/spec/models/s3_keys_spec.rb +1 -1
  565. data/spec/models/s3_object_storage_sso_spec.rb +1 -1
  566. data/spec/models/server_entities_spec.rb +1 -1
  567. data/spec/models/server_properties_spec.rb +14 -2
  568. data/spec/models/server_spec.rb +1 -1
  569. data/spec/models/servers_spec.rb +1 -1
  570. data/spec/models/snapshot_properties_spec.rb +1 -1
  571. data/spec/models/snapshot_spec.rb +1 -1
  572. data/spec/models/snapshots_spec.rb +1 -1
  573. data/spec/models/target_port_range_spec.rb +40 -0
  574. data/spec/models/template_properties_spec.rb +52 -0
  575. data/spec/models/template_spec.rb +58 -0
  576. data/spec/models/templates_spec.rb +52 -0
  577. data/spec/models/token_spec.rb +34 -0
  578. data/spec/models/type_spec.rb +1 -1
  579. data/spec/models/user_metadata_spec.rb +1 -1
  580. data/spec/models/user_post_spec.rb +34 -0
  581. data/spec/models/user_properties_post_spec.rb +76 -0
  582. data/spec/models/user_properties_put_spec.rb +70 -0
  583. data/spec/models/user_properties_spec.rb +1 -7
  584. data/spec/models/user_put_spec.rb +40 -0
  585. data/spec/models/user_spec.rb +1 -1
  586. data/spec/models/users_entities_spec.rb +1 -1
  587. data/spec/models/users_spec.rb +1 -1
  588. data/spec/models/volume_properties_spec.rb +14 -8
  589. data/spec/models/volume_spec.rb +1 -1
  590. data/spec/models/volumes_spec.rb +1 -1
  591. data/spec/spec_helper.rb +1 -1
  592. metadata +505 -160
  593. data/DOCS.md +0 -14618
  594. data/lib/ionoscloud/api/nic_api.rb +0 -1222
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4024357ab13ae688d6baea2f0549d9b971874ef781800b90458864fb00507db5
4
- data.tar.gz: 6c6d81bf45d3be9ea5410d94cef3083adc81e341144e22e7c087729261f44b03
3
+ metadata.gz: b0caaa84b59598694fb2850355777a359bb7af0d8bedbf3dbee5c35487221154
4
+ data.tar.gz: 298e69dea771ece2f3891e621c481040153c862909b8430169953df3ad7b9465
5
5
  SHA512:
6
- metadata.gz: 56577cf97195e1ec9ed5b8d4800fd361a8398767f71dd09e88044b2f9a2390bc664ed75b2ea5c119d9773dae213c7c44f5a9fb5f6a0c4f9198541845a61e14d0
7
- data.tar.gz: 98c8b6e5b42e0ab7c15c2828c911eabe4d3b17201acf2bd53e03802459eb6f4aa3cf3124c960480148641954fdb1d036fd07dd96e964cf3166659f2e861e9d3d
6
+ metadata.gz: 96970005268b57d9a88a3c49cd94582f816b69cd21e85a5b17b4cf70a0c69e63c719560bf0987a96ebba78074ca9118b466eeac145ec62cdd981a073a157d69b
7
+ data.tar.gz: 31b2729a7f21ca09136dc1724cc36abf3b75011be24a44262e1a94b2974d96c0166c2537e61be668b4ec09c8bde9913d2140467ed8b99243784f4101e141fe38
data/README.md CHANGED
@@ -10,8 +10,8 @@ The API allows you to perform a variety of management tasks such as spinning up
10
10
 
11
11
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
12
12
 
13
- - API version: 5.0
14
- - Package version: 5.0.0
13
+ - API version: 6.0-SDK.1
14
+ - Package version: 6.0.0.beta.3
15
15
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
16
16
 
17
17
  ## Installation
@@ -27,16 +27,16 @@ gem build ionoscloud.gemspec
27
27
  Then either install the gem locally:
28
28
 
29
29
  ```shell
30
- gem install ./ionoscloud-5.0.0.gem
30
+ gem install ./ionoscloud-6.0.0.beta.3.gem
31
31
  ```
32
32
 
33
- (for development, run `gem install --dev ./ionoscloud-5.0.0.gem` to install the development dependencies)
33
+ (for development, run `gem install --dev ./ionoscloud-6.0.0.beta.3.gem` to install the development dependencies)
34
34
 
35
35
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
36
36
 
37
37
  Finally add this to the Gemfile:
38
38
 
39
- gem 'ionoscloud', '~> 5.0.0'
39
+ gem 'ionoscloud', '~> 6.0.0.beta.3'
40
40
 
41
41
  ### Install from Git
42
42
 
@@ -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,22 @@
1
+ # BackupUnitProperties
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A name of that resource (only alphanumeric characters are acceptable) | |
8
+ | **password** | **String** | the password associated to that resource | [optional] |
9
+ | **email** | **String** | The email associated with the backup unit. Bear in mind that this email does not be the same email as of the user. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ionoscloud'
15
+
16
+ instance = Ionoscloud::BackupUnitProperties.new(
17
+ name: BackupUnitName,
18
+ password: mypass123,
19
+ email: email@email.com
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # BackupUnitSSO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sso_url** | **String** | The backup unit single sign on url | [optional][readonly] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ionoscloud'
13
+
14
+ instance = Ionoscloud::BackupUnitSSO.new(
15
+ sso_url: https://<hostname>/?jwt=eyJ0eXAiO...W47AN5-_x7E
16
+ )
17
+ ```
18
+
@@ -0,0 +1,24 @@
1
+ # BackupUnits
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
+ | **items** | [**Array&lt;BackupUnit&gt;**](BackupUnit.md) | Array of items in that collection | [optional][readonly] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ionoscloud'
16
+
17
+ instance = Ionoscloud::BackupUnits.new(
18
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
19
+ type: collection,
20
+ href: <RESOURCE-URI>,
21
+ items: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,594 @@
1
+ # BackupUnitsApi
2
+
3
+ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**backupunits_delete**](BackupUnitsApi.md#backupunits_delete) | **DELETE** /backupunits/{backupunitId} | Delete a Backup Unit |
8
+ | [**backupunits_find_by_id**](BackupUnitsApi.md#backupunits_find_by_id) | **GET** /backupunits/{backupunitId} | Returns the specified Backup Unit |
9
+ | [**backupunits_get**](BackupUnitsApi.md#backupunits_get) | **GET** /backupunits | List Backup Units |
10
+ | [**backupunits_patch**](BackupUnitsApi.md#backupunits_patch) | **PATCH** /backupunits/{backupunitId} | Partially modify a Backup Unit |
11
+ | [**backupunits_post**](BackupUnitsApi.md#backupunits_post) | **POST** /backupunits | Create a Backup Unit |
12
+ | [**backupunits_put**](BackupUnitsApi.md#backupunits_put) | **PUT** /backupunits/{backupunitId} | Modify a Backup Unit |
13
+ | [**backupunits_ssourl_get**](BackupUnitsApi.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
+ > 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::BackupUnitsApi.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
+ api_instance.backupunits_delete(backupunit_id, opts)
52
+ rescue Ionoscloud::ApiError => e
53
+ puts "Error when calling BackupUnitsApi->backupunits_delete: #{e}"
54
+ end
55
+ ```
56
+
57
+ #### Using the backupunits_delete_with_http_info variant
58
+
59
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
60
+
61
+ > <Array(nil, Integer, Hash)> backupunits_delete_with_http_info(backupunit_id, opts)
62
+
63
+ ```ruby
64
+ begin
65
+ # Delete a Backup Unit
66
+ data, status_code, headers = api_instance.backupunits_delete_with_http_info(backupunit_id, opts)
67
+ p status_code # => 2xx
68
+ p headers # => { ... }
69
+ p data # => nil
70
+ rescue Ionoscloud::ApiError => e
71
+ puts "Error when calling BackupUnitsApi->backupunits_delete_with_http_info: #{e}"
72
+ end
73
+ ```
74
+
75
+ ### Parameters
76
+
77
+ | Name | Type | Description | Notes |
78
+ | ---- | ---- | ----------- | ----- |
79
+ | **backupunit_id** | **String** | The unique ID of the backup Unit | |
80
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
81
+ | **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] |
82
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
83
+
84
+ ### Return type
85
+
86
+ nil (empty response body)
87
+
88
+ ### Authorization
89
+
90
+ Basic Authentication, Token Authentication
91
+
92
+ ### HTTP request headers
93
+
94
+ - **Content-Type**: Not defined
95
+ - **Accept**: application/json
96
+
97
+
98
+ ## backupunits_find_by_id
99
+
100
+ > <BackupUnit> backupunits_find_by_id(backupunit_id, opts)
101
+
102
+ Returns the specified Backup Unit
103
+
104
+ You can retrieve the details of an specific backup unit.
105
+
106
+ ### Examples
107
+
108
+ ```ruby
109
+ require 'time'
110
+ require 'ionoscloud'
111
+ # setup authorization
112
+ Ionoscloud.configure do |config|
113
+ # Configure HTTP basic authorization: Basic Authentication
114
+ config.username = 'YOUR USERNAME'
115
+ config.password = 'YOUR PASSWORD'
116
+
117
+ # Configure API key authorization: Token Authentication
118
+ config.api_key['Authorization'] = 'YOUR API KEY'
119
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
120
+ # config.api_key_prefix['Authorization'] = 'Bearer'
121
+ end
122
+
123
+ api_instance = Ionoscloud::BackupUnitsApi.new
124
+ backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit
125
+ opts = {
126
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
127
+ 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
128
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
129
+ }
130
+
131
+ begin
132
+ # Returns the specified Backup Unit
133
+ result = api_instance.backupunits_find_by_id(backupunit_id, opts)
134
+ p result
135
+ rescue Ionoscloud::ApiError => e
136
+ puts "Error when calling BackupUnitsApi->backupunits_find_by_id: #{e}"
137
+ end
138
+ ```
139
+
140
+ #### Using the backupunits_find_by_id_with_http_info variant
141
+
142
+ This returns an Array which contains the response data, status code and headers.
143
+
144
+ > <Array(<BackupUnit>, Integer, Hash)> backupunits_find_by_id_with_http_info(backupunit_id, opts)
145
+
146
+ ```ruby
147
+ begin
148
+ # Returns the specified Backup Unit
149
+ data, status_code, headers = api_instance.backupunits_find_by_id_with_http_info(backupunit_id, opts)
150
+ p status_code # => 2xx
151
+ p headers # => { ... }
152
+ p data # => <BackupUnit>
153
+ rescue Ionoscloud::ApiError => e
154
+ puts "Error when calling BackupUnitsApi->backupunits_find_by_id_with_http_info: #{e}"
155
+ end
156
+ ```
157
+
158
+ ### Parameters
159
+
160
+ | Name | Type | Description | Notes |
161
+ | ---- | ---- | ----------- | ----- |
162
+ | **backupunit_id** | **String** | The unique ID of the backup unit | |
163
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
164
+ | **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] |
165
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
166
+
167
+ ### Return type
168
+
169
+ [**BackupUnit**](BackupUnit.md)
170
+
171
+ ### Authorization
172
+
173
+ Basic Authentication, Token Authentication
174
+
175
+ ### HTTP request headers
176
+
177
+ - **Content-Type**: Not defined
178
+ - **Accept**: application/json
179
+
180
+
181
+ ## backupunits_get
182
+
183
+ > <BackupUnits> backupunits_get(opts)
184
+
185
+ List Backup Units
186
+
187
+ You can retrieve a complete list of backup Units that you have access to.
188
+
189
+ ### Examples
190
+
191
+ ```ruby
192
+ require 'time'
193
+ require 'ionoscloud'
194
+ # setup authorization
195
+ Ionoscloud.configure do |config|
196
+ # Configure HTTP basic authorization: Basic Authentication
197
+ config.username = 'YOUR USERNAME'
198
+ config.password = 'YOUR PASSWORD'
199
+
200
+ # Configure API key authorization: Token Authentication
201
+ config.api_key['Authorization'] = 'YOUR API KEY'
202
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
203
+ # config.api_key_prefix['Authorization'] = 'Bearer'
204
+ end
205
+
206
+ api_instance = Ionoscloud::BackupUnitsApi.new
207
+ opts = {
208
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
209
+ 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
210
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
211
+ }
212
+
213
+ begin
214
+ # List Backup Units
215
+ result = api_instance.backupunits_get(opts)
216
+ p result
217
+ rescue Ionoscloud::ApiError => e
218
+ puts "Error when calling BackupUnitsApi->backupunits_get: #{e}"
219
+ end
220
+ ```
221
+
222
+ #### Using the backupunits_get_with_http_info variant
223
+
224
+ This returns an Array which contains the response data, status code and headers.
225
+
226
+ > <Array(<BackupUnits>, Integer, Hash)> backupunits_get_with_http_info(opts)
227
+
228
+ ```ruby
229
+ begin
230
+ # List Backup Units
231
+ data, status_code, headers = api_instance.backupunits_get_with_http_info(opts)
232
+ p status_code # => 2xx
233
+ p headers # => { ... }
234
+ p data # => <BackupUnits>
235
+ rescue Ionoscloud::ApiError => e
236
+ puts "Error when calling BackupUnitsApi->backupunits_get_with_http_info: #{e}"
237
+ end
238
+ ```
239
+
240
+ ### Parameters
241
+
242
+ | Name | Type | Description | Notes |
243
+ | ---- | ---- | ----------- | ----- |
244
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
245
+ | **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] |
246
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
247
+
248
+ ### Return type
249
+
250
+ [**BackupUnits**](BackupUnits.md)
251
+
252
+ ### Authorization
253
+
254
+ Basic Authentication, Token Authentication
255
+
256
+ ### HTTP request headers
257
+
258
+ - **Content-Type**: Not defined
259
+ - **Accept**: application/json
260
+
261
+
262
+ ## backupunits_patch
263
+
264
+ > <BackupUnit> backupunits_patch(backupunit_id, backup_unit_properties, opts)
265
+
266
+ Partially modify a Backup Unit
267
+
268
+ You can use update a Backup Unit properties.
269
+
270
+ ### Examples
271
+
272
+ ```ruby
273
+ require 'time'
274
+ require 'ionoscloud'
275
+ # setup authorization
276
+ Ionoscloud.configure do |config|
277
+ # Configure HTTP basic authorization: Basic Authentication
278
+ config.username = 'YOUR USERNAME'
279
+ config.password = 'YOUR PASSWORD'
280
+
281
+ # Configure API key authorization: Token Authentication
282
+ config.api_key['Authorization'] = 'YOUR API KEY'
283
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
284
+ # config.api_key_prefix['Authorization'] = 'Bearer'
285
+ end
286
+
287
+ api_instance = Ionoscloud::BackupUnitsApi.new
288
+ backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit
289
+ backup_unit_properties = Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'}) # BackupUnitProperties | Modified backup Unit properties
290
+ opts = {
291
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
292
+ 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
293
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
294
+ }
295
+
296
+ begin
297
+ # Partially modify a Backup Unit
298
+ result = api_instance.backupunits_patch(backupunit_id, backup_unit_properties, opts)
299
+ p result
300
+ rescue Ionoscloud::ApiError => e
301
+ puts "Error when calling BackupUnitsApi->backupunits_patch: #{e}"
302
+ end
303
+ ```
304
+
305
+ #### Using the backupunits_patch_with_http_info variant
306
+
307
+ This returns an Array which contains the response data, status code and headers.
308
+
309
+ > <Array(<BackupUnit>, Integer, Hash)> backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts)
310
+
311
+ ```ruby
312
+ begin
313
+ # Partially modify a Backup Unit
314
+ data, status_code, headers = api_instance.backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts)
315
+ p status_code # => 2xx
316
+ p headers # => { ... }
317
+ p data # => <BackupUnit>
318
+ rescue Ionoscloud::ApiError => e
319
+ puts "Error when calling BackupUnitsApi->backupunits_patch_with_http_info: #{e}"
320
+ end
321
+ ```
322
+
323
+ ### Parameters
324
+
325
+ | Name | Type | Description | Notes |
326
+ | ---- | ---- | ----------- | ----- |
327
+ | **backupunit_id** | **String** | The unique ID of the backup unit | |
328
+ | **backup_unit_properties** | [**BackupUnitProperties**](BackupUnitProperties.md) | Modified backup Unit properties | |
329
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
330
+ | **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] |
331
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
332
+
333
+ ### Return type
334
+
335
+ [**BackupUnit**](BackupUnit.md)
336
+
337
+ ### Authorization
338
+
339
+ Basic Authentication, Token Authentication
340
+
341
+ ### HTTP request headers
342
+
343
+ - **Content-Type**: application/json
344
+ - **Accept**: application/json
345
+
346
+
347
+ ## backupunits_post
348
+
349
+ > <BackupUnit> backupunits_post(backup_unit, opts)
350
+
351
+ Create a Backup Unit
352
+
353
+ 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
354
+
355
+ ### Examples
356
+
357
+ ```ruby
358
+ require 'time'
359
+ require 'ionoscloud'
360
+ # setup authorization
361
+ Ionoscloud.configure do |config|
362
+ # Configure HTTP basic authorization: Basic Authentication
363
+ config.username = 'YOUR USERNAME'
364
+ config.password = 'YOUR PASSWORD'
365
+
366
+ # Configure API key authorization: Token Authentication
367
+ config.api_key['Authorization'] = 'YOUR API KEY'
368
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
369
+ # config.api_key_prefix['Authorization'] = 'Bearer'
370
+ end
371
+
372
+ api_instance = Ionoscloud::BackupUnitsApi.new
373
+ backup_unit = Ionoscloud::BackupUnit.new({properties: Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'})}) # BackupUnit | Payload containing data to create a new Backup Unit
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
+ # Create a Backup Unit
382
+ result = api_instance.backupunits_post(backup_unit, opts)
383
+ p result
384
+ rescue Ionoscloud::ApiError => e
385
+ puts "Error when calling BackupUnitsApi->backupunits_post: #{e}"
386
+ end
387
+ ```
388
+
389
+ #### Using the backupunits_post_with_http_info variant
390
+
391
+ This returns an Array which contains the response data, status code and headers.
392
+
393
+ > <Array(<BackupUnit>, Integer, Hash)> backupunits_post_with_http_info(backup_unit, opts)
394
+
395
+ ```ruby
396
+ begin
397
+ # Create a Backup Unit
398
+ data, status_code, headers = api_instance.backupunits_post_with_http_info(backup_unit, opts)
399
+ p status_code # => 2xx
400
+ p headers # => { ... }
401
+ p data # => <BackupUnit>
402
+ rescue Ionoscloud::ApiError => e
403
+ puts "Error when calling BackupUnitsApi->backupunits_post_with_http_info: #{e}"
404
+ end
405
+ ```
406
+
407
+ ### Parameters
408
+
409
+ | Name | Type | Description | Notes |
410
+ | ---- | ---- | ----------- | ----- |
411
+ | **backup_unit** | [**BackupUnit**](BackupUnit.md) | Payload containing data to create a new Backup Unit | |
412
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
413
+ | **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] |
414
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
415
+
416
+ ### Return type
417
+
418
+ [**BackupUnit**](BackupUnit.md)
419
+
420
+ ### Authorization
421
+
422
+ Basic Authentication, Token Authentication
423
+
424
+ ### HTTP request headers
425
+
426
+ - **Content-Type**: application/json
427
+ - **Accept**: application/json
428
+
429
+
430
+ ## backupunits_put
431
+
432
+ > <BackupUnit> backupunits_put(backupunit_id, backup_unit, opts)
433
+
434
+ Modify a Backup Unit
435
+
436
+ You can use update a Backup Unit properties.
437
+
438
+ ### Examples
439
+
440
+ ```ruby
441
+ require 'time'
442
+ require 'ionoscloud'
443
+ # setup authorization
444
+ Ionoscloud.configure do |config|
445
+ # Configure HTTP basic authorization: Basic Authentication
446
+ config.username = 'YOUR USERNAME'
447
+ config.password = 'YOUR PASSWORD'
448
+
449
+ # Configure API key authorization: Token Authentication
450
+ config.api_key['Authorization'] = 'YOUR API KEY'
451
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
452
+ # config.api_key_prefix['Authorization'] = 'Bearer'
453
+ end
454
+
455
+ api_instance = Ionoscloud::BackupUnitsApi.new
456
+ backupunit_id = 'backupunit_id_example' # String | The unique ID of the backup unit
457
+ backup_unit = Ionoscloud::BackupUnit.new({properties: Ionoscloud::BackupUnitProperties.new({name: 'BackupUnitName'})}) # BackupUnit | Modified backup Unit
458
+ opts = {
459
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
460
+ 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
461
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
462
+ }
463
+
464
+ begin
465
+ # Modify a Backup Unit
466
+ result = api_instance.backupunits_put(backupunit_id, backup_unit, opts)
467
+ p result
468
+ rescue Ionoscloud::ApiError => e
469
+ puts "Error when calling BackupUnitsApi->backupunits_put: #{e}"
470
+ end
471
+ ```
472
+
473
+ #### Using the backupunits_put_with_http_info variant
474
+
475
+ This returns an Array which contains the response data, status code and headers.
476
+
477
+ > <Array(<BackupUnit>, Integer, Hash)> backupunits_put_with_http_info(backupunit_id, backup_unit, opts)
478
+
479
+ ```ruby
480
+ begin
481
+ # Modify a Backup Unit
482
+ data, status_code, headers = api_instance.backupunits_put_with_http_info(backupunit_id, backup_unit, opts)
483
+ p status_code # => 2xx
484
+ p headers # => { ... }
485
+ p data # => <BackupUnit>
486
+ rescue Ionoscloud::ApiError => e
487
+ puts "Error when calling BackupUnitsApi->backupunits_put_with_http_info: #{e}"
488
+ end
489
+ ```
490
+
491
+ ### Parameters
492
+
493
+ | Name | Type | Description | Notes |
494
+ | ---- | ---- | ----------- | ----- |
495
+ | **backupunit_id** | **String** | The unique ID of the backup unit | |
496
+ | **backup_unit** | [**BackupUnit**](BackupUnit.md) | Modified backup Unit | |
497
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
498
+ | **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] |
499
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
500
+
501
+ ### Return type
502
+
503
+ [**BackupUnit**](BackupUnit.md)
504
+
505
+ ### Authorization
506
+
507
+ Basic Authentication, Token Authentication
508
+
509
+ ### HTTP request headers
510
+
511
+ - **Content-Type**: application/json
512
+ - **Accept**: application/json
513
+
514
+
515
+ ## backupunits_ssourl_get
516
+
517
+ > <BackupUnitSSO> backupunits_ssourl_get(backupunit_id, opts)
518
+
519
+ Returns a single signon URL for the specified Backup Unit
520
+
521
+ Returns a single signon URL for the specified Backup Unit.
522
+
523
+ ### Examples
524
+
525
+ ```ruby
526
+ require 'time'
527
+ require 'ionoscloud'
528
+ # setup authorization
529
+ Ionoscloud.configure do |config|
530
+ # Configure HTTP basic authorization: Basic Authentication
531
+ config.username = 'YOUR USERNAME'
532
+ config.password = 'YOUR PASSWORD'
533
+
534
+ # Configure API key authorization: Token Authentication
535
+ config.api_key['Authorization'] = 'YOUR API KEY'
536
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
537
+ # config.api_key_prefix['Authorization'] = 'Bearer'
538
+ end
539
+
540
+ api_instance = Ionoscloud::BackupUnitsApi.new
541
+ backupunit_id = 'backupunit_id_example' # String | The unique UUID of the backup unit
542
+ opts = {
543
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
544
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
545
+ }
546
+
547
+ begin
548
+ # Returns a single signon URL for the specified Backup Unit
549
+ result = api_instance.backupunits_ssourl_get(backupunit_id, opts)
550
+ p result
551
+ rescue Ionoscloud::ApiError => e
552
+ puts "Error when calling BackupUnitsApi->backupunits_ssourl_get: #{e}"
553
+ end
554
+ ```
555
+
556
+ #### Using the backupunits_ssourl_get_with_http_info variant
557
+
558
+ This returns an Array which contains the response data, status code and headers.
559
+
560
+ > <Array(<BackupUnitSSO>, Integer, Hash)> backupunits_ssourl_get_with_http_info(backupunit_id, opts)
561
+
562
+ ```ruby
563
+ begin
564
+ # Returns a single signon URL for the specified Backup Unit
565
+ data, status_code, headers = api_instance.backupunits_ssourl_get_with_http_info(backupunit_id, opts)
566
+ p status_code # => 2xx
567
+ p headers # => { ... }
568
+ p data # => <BackupUnitSSO>
569
+ rescue Ionoscloud::ApiError => e
570
+ puts "Error when calling BackupUnitsApi->backupunits_ssourl_get_with_http_info: #{e}"
571
+ end
572
+ ```
573
+
574
+ ### Parameters
575
+
576
+ | Name | Type | Description | Notes |
577
+ | ---- | ---- | ----------- | ----- |
578
+ | **backupunit_id** | **String** | The unique UUID of the backup unit | |
579
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
580
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
581
+
582
+ ### Return type
583
+
584
+ [**BackupUnitSSO**](BackupUnitSSO.md)
585
+
586
+ ### Authorization
587
+
588
+ Basic Authentication, Token Authentication
589
+
590
+ ### HTTP request headers
591
+
592
+ - **Content-Type**: Not defined
593
+ - **Accept**: application/json
594
+