ionoscloud 5.1.1 → 6.0.0.beta.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (536) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -19
  3. data/docs/CHANGELOG.md +1 -0
  4. data/docs/README.md +4 -4
  5. data/docs/api/BackupUnitsApi.md +594 -0
  6. data/docs/api/ContractResourcesApi.md +89 -0
  7. data/docs/api/DataCentersApi.md +516 -0
  8. data/docs/api/DefaultApi.md +8 -19
  9. data/docs/api/FirewallRulesApi.md +552 -0
  10. data/docs/api/FlowLogsApi.md +540 -0
  11. data/docs/api/IPBlocksApi.md +50 -51
  12. data/docs/api/ImagesApi.md +428 -0
  13. data/docs/api/KubernetesApi.md +131 -211
  14. data/docs/api/LabelsApi.md +2338 -0
  15. data/docs/api/LansApi.md +794 -0
  16. data/docs/api/LoadBalancersApi.md +877 -0
  17. data/docs/api/LocationsApi.md +259 -0
  18. data/docs/api/NATGatewaysApi.md +1574 -0
  19. data/docs/api/NetworkInterfacesApi.md +540 -0
  20. data/docs/api/NetworkLoadBalancersApi.md +1586 -0
  21. data/docs/api/PrivateCrossConnectsApi.md +426 -0
  22. data/docs/api/{RequestApi.md → RequestsApi.md} +36 -36
  23. data/docs/api/ServersApi.md +1908 -0
  24. data/docs/api/SnapshotsApi.md +428 -0
  25. data/docs/api/TemplatesApi.md +165 -0
  26. data/docs/api/UserManagementApi.md +173 -687
  27. data/docs/api/UserS3KeysApi.md +516 -0
  28. data/docs/api/VolumesApi.md +709 -0
  29. data/docs/models/AttachedVolumes.md +1 -1
  30. data/docs/models/Cdroms.md +1 -1
  31. data/docs/models/Contracts.md +24 -0
  32. data/docs/models/CpuArchitectureProperties.md +24 -0
  33. data/docs/models/DataCenterEntities.md +5 -1
  34. data/docs/models/DatacenterProperties.md +3 -1
  35. data/docs/models/FirewallruleProperties.md +3 -1
  36. data/docs/models/FlowLog.md +26 -0
  37. data/docs/models/FlowLogProperties.md +24 -0
  38. data/docs/models/FlowLogPut.md +24 -0
  39. data/docs/models/FlowLogs.md +30 -0
  40. data/docs/models/Group.md +1 -1
  41. data/docs/models/GroupMembers.md +1 -1
  42. data/docs/models/GroupProperties.md +7 -1
  43. data/docs/models/GroupShare.md +1 -1
  44. data/docs/models/GroupShares.md +1 -1
  45. data/docs/models/GroupUsers.md +1 -1
  46. data/docs/models/Groups.md +1 -1
  47. data/docs/models/KubernetesAutoScaling.md +2 -2
  48. data/docs/models/KubernetesClusterProperties.md +1 -1
  49. data/docs/models/KubernetesClusterPropertiesForPost.md +1 -1
  50. data/docs/models/KubernetesClusterPropertiesForPut.md +1 -1
  51. data/docs/models/KubernetesClusters.md +1 -1
  52. data/docs/models/KubernetesMaintenanceWindow.md +2 -2
  53. data/docs/models/KubernetesNodePoolLan.md +5 -1
  54. data/docs/models/KubernetesNodePoolLanRoutes.md +20 -0
  55. data/docs/models/KubernetesNodePools.md +1 -1
  56. data/docs/models/Lans.md +1 -1
  57. data/docs/models/LocationProperties.md +3 -1
  58. data/docs/models/NatGateway.md +28 -0
  59. data/docs/models/NatGatewayEntities.md +20 -0
  60. data/docs/models/NatGatewayLanProperties.md +20 -0
  61. data/docs/models/NatGatewayProperties.md +22 -0
  62. data/docs/models/NatGatewayPut.md +24 -0
  63. data/docs/models/NatGatewayRule.md +26 -0
  64. data/docs/models/NatGatewayRuleProperties.md +30 -0
  65. data/docs/models/NatGatewayRuleProtocol.md +15 -0
  66. data/docs/models/NatGatewayRulePut.md +24 -0
  67. data/docs/models/NatGatewayRuleType.md +15 -0
  68. data/docs/models/NatGatewayRules.md +24 -0
  69. data/docs/models/NatGateways.md +30 -0
  70. data/docs/models/NetworkLoadBalancer.md +28 -0
  71. data/docs/models/NetworkLoadBalancerEntities.md +20 -0
  72. data/docs/models/NetworkLoadBalancerForwardingRule.md +26 -0
  73. data/docs/models/NetworkLoadBalancerForwardingRuleHealthCheck.md +24 -0
  74. data/docs/models/NetworkLoadBalancerForwardingRuleProperties.md +30 -0
  75. data/docs/models/NetworkLoadBalancerForwardingRulePut.md +24 -0
  76. data/docs/models/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
  77. data/docs/models/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
  78. data/docs/models/NetworkLoadBalancerForwardingRules.md +30 -0
  79. data/docs/models/NetworkLoadBalancerProperties.md +26 -0
  80. data/docs/models/NetworkLoadBalancerPut.md +24 -0
  81. data/docs/models/NetworkLoadBalancers.md +30 -0
  82. data/docs/models/NicEntities.md +2 -0
  83. data/docs/models/NicProperties.md +6 -2
  84. data/docs/models/NicPut.md +24 -0
  85. data/docs/models/Nics.md +1 -1
  86. data/docs/models/PrivateCrossConnectProperties.md +1 -1
  87. data/docs/models/RemoteConsoleUrl.md +18 -0
  88. data/docs/models/Resource.md +1 -1
  89. data/docs/models/ResourceGroups.md +1 -1
  90. data/docs/models/ResourceLimits.md +11 -1
  91. data/docs/models/ResourceProperties.md +1 -1
  92. data/docs/models/Resources.md +1 -1
  93. data/docs/models/ResourcesUsers.md +1 -1
  94. data/docs/models/S3Bucket.md +1 -1
  95. data/docs/models/S3Key.md +1 -1
  96. data/docs/models/S3Keys.md +1 -1
  97. data/docs/models/ServerProperties.md +6 -2
  98. data/docs/models/TargetPortRange.md +20 -0
  99. data/docs/models/Template.md +26 -0
  100. data/docs/models/TemplateProperties.md +24 -0
  101. data/docs/models/Templates.md +24 -0
  102. data/docs/models/Token.md +18 -0
  103. data/docs/models/VolumeProperties.md +5 -3
  104. data/docs/summary.md +386 -159
  105. data/ionoscloud.gemspec +3 -3
  106. data/lib/ionoscloud/api/_api.rb +9 -9
  107. data/lib/ionoscloud/api/{backup_unit_api.rb → backup_units_api.rb} +101 -101
  108. data/lib/ionoscloud/api/contract_resources_api.rb +96 -0
  109. data/lib/ionoscloud/api/data_centers_api.rb +532 -0
  110. data/lib/ionoscloud/api/firewall_rules_api.rb +640 -0
  111. data/lib/ionoscloud/api/flow_logs_api.rb +622 -0
  112. data/lib/ionoscloud/api/{image_api.rb → images_api.rb} +71 -71
  113. data/lib/ionoscloud/api/ip_blocks_api.rb +55 -55
  114. data/lib/ionoscloud/api/kubernetes_api.rb +131 -194
  115. data/lib/ionoscloud/api/{label_api.rb → labels_api.rb} +416 -470
  116. data/lib/ionoscloud/api/{lan_api.rb → lans_api.rb} +178 -178
  117. data/lib/ionoscloud/api/{load_balancer_api.rb → load_balancers_api.rb} +198 -216
  118. data/lib/ionoscloud/api/{location_api.rb → locations_api.rb} +49 -49
  119. data/lib/ionoscloud/api/nat_gateways_api.rb +1672 -0
  120. data/lib/ionoscloud/api/network_interfaces_api.rb +604 -0
  121. data/lib/ionoscloud/api/network_load_balancers_api.rb +1690 -0
  122. data/lib/ionoscloud/api/{private_cross_connect_api.rb → private_cross_connects_api.rb} +76 -76
  123. data/lib/ionoscloud/api/{request_api.rb → requests_api.rb} +45 -45
  124. data/lib/ionoscloud/api/servers_api.rb +2023 -0
  125. data/lib/ionoscloud/api/{snapshot_api.rb → snapshots_api.rb} +77 -77
  126. data/lib/ionoscloud/api/templates_api.rb +164 -0
  127. data/lib/ionoscloud/api/user_management_api.rb +172 -667
  128. data/lib/ionoscloud/api/user_s3_keys_api.rb +517 -0
  129. data/lib/ionoscloud/api/{volume_api.rb → volumes_api.rb} +145 -145
  130. data/lib/ionoscloud/api_client.rb +5 -5
  131. data/lib/ionoscloud/api_error.rb +2 -2
  132. data/lib/ionoscloud/configuration.rb +4 -4
  133. data/lib/ionoscloud/models/attached_volumes.rb +2 -2
  134. data/lib/ionoscloud/models/backup_unit.rb +2 -2
  135. data/lib/ionoscloud/models/backup_unit_properties.rb +2 -2
  136. data/lib/ionoscloud/models/backup_unit_sso.rb +2 -2
  137. data/lib/ionoscloud/models/backup_units.rb +2 -2
  138. data/lib/ionoscloud/models/balanced_nics.rb +2 -2
  139. data/lib/ionoscloud/models/cdroms.rb +2 -2
  140. data/lib/ionoscloud/models/connectable_datacenter.rb +2 -2
  141. data/lib/ionoscloud/models/contract.rb +2 -2
  142. data/lib/ionoscloud/models/contract_properties.rb +2 -2
  143. data/lib/ionoscloud/models/contracts.rb +251 -0
  144. data/lib/ionoscloud/models/cpu_architecture_properties.rb +249 -0
  145. data/lib/ionoscloud/models/data_center_entities.rb +24 -6
  146. data/lib/ionoscloud/models/datacenter.rb +2 -2
  147. data/lib/ionoscloud/models/datacenter_element_metadata.rb +4 -4
  148. data/lib/ionoscloud/models/datacenter_properties.rb +18 -6
  149. data/lib/ionoscloud/models/datacenters.rb +2 -2
  150. data/lib/ionoscloud/models/error.rb +2 -2
  151. data/lib/ionoscloud/models/error_message.rb +2 -2
  152. data/lib/ionoscloud/models/firewall_rule.rb +2 -2
  153. data/lib/ionoscloud/models/firewall_rules.rb +2 -2
  154. data/lib/ionoscloud/models/firewallrule_properties.rb +28 -6
  155. data/lib/ionoscloud/models/flow_log.rb +262 -0
  156. data/lib/ionoscloud/models/flow_log_properties.rb +315 -0
  157. data/lib/ionoscloud/models/{kubernetes_config.rb → flow_log_put.rb} +9 -43
  158. data/lib/ionoscloud/models/flow_logs.rb +280 -0
  159. data/lib/ionoscloud/models/group.rb +2 -2
  160. data/lib/ionoscloud/models/group_entities.rb +2 -2
  161. data/lib/ionoscloud/models/group_members.rb +2 -2
  162. data/lib/ionoscloud/models/group_properties.rb +36 -6
  163. data/lib/ionoscloud/models/group_share.rb +2 -2
  164. data/lib/ionoscloud/models/group_share_properties.rb +2 -2
  165. data/lib/ionoscloud/models/group_shares.rb +2 -2
  166. data/lib/ionoscloud/models/group_users.rb +2 -2
  167. data/lib/ionoscloud/models/groups.rb +2 -2
  168. data/lib/ionoscloud/models/image.rb +2 -2
  169. data/lib/ionoscloud/models/image_properties.rb +2 -2
  170. data/lib/ionoscloud/models/images.rb +2 -2
  171. data/lib/ionoscloud/models/info.rb +2 -2
  172. data/lib/ionoscloud/models/ip_block.rb +2 -2
  173. data/lib/ionoscloud/models/ip_block_properties.rb +2 -2
  174. data/lib/ionoscloud/models/ip_blocks.rb +2 -2
  175. data/lib/ionoscloud/models/ip_consumer.rb +2 -2
  176. data/lib/ionoscloud/models/ip_failover.rb +2 -2
  177. data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +12 -2
  178. data/lib/ionoscloud/models/kubernetes_cluster.rb +2 -2
  179. data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +2 -2
  180. data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +2 -2
  181. data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +2 -2
  182. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +3 -3
  183. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +3 -3
  184. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +3 -3
  185. data/lib/ionoscloud/models/kubernetes_clusters.rb +3 -3
  186. data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +12 -2
  187. data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
  188. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +4 -4
  189. data/lib/ionoscloud/models/kubernetes_node_pool.rb +2 -2
  190. data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +2 -2
  191. data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +2 -2
  192. data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +28 -6
  193. data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +229 -0
  194. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +2 -2
  195. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +2 -2
  196. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +2 -2
  197. data/lib/ionoscloud/models/kubernetes_node_pools.rb +3 -3
  198. data/lib/ionoscloud/models/kubernetes_node_properties.rb +2 -2
  199. data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
  200. data/lib/ionoscloud/models/label.rb +2 -2
  201. data/lib/ionoscloud/models/label_properties.rb +2 -2
  202. data/lib/ionoscloud/models/label_resource.rb +2 -2
  203. data/lib/ionoscloud/models/label_resource_properties.rb +2 -2
  204. data/lib/ionoscloud/models/label_resources.rb +2 -2
  205. data/lib/ionoscloud/models/labels.rb +2 -2
  206. data/lib/ionoscloud/models/lan.rb +2 -2
  207. data/lib/ionoscloud/models/lan_entities.rb +2 -2
  208. data/lib/ionoscloud/models/lan_nics.rb +2 -2
  209. data/lib/ionoscloud/models/lan_post.rb +2 -2
  210. data/lib/ionoscloud/models/lan_properties.rb +2 -2
  211. data/lib/ionoscloud/models/lan_properties_post.rb +2 -2
  212. data/lib/ionoscloud/models/lans.rb +3 -3
  213. data/lib/ionoscloud/models/loadbalancer.rb +2 -2
  214. data/lib/ionoscloud/models/loadbalancer_entities.rb +2 -2
  215. data/lib/ionoscloud/models/loadbalancer_properties.rb +2 -2
  216. data/lib/ionoscloud/models/loadbalancers.rb +2 -2
  217. data/lib/ionoscloud/models/location.rb +2 -2
  218. data/lib/ionoscloud/models/location_properties.rb +18 -6
  219. data/lib/ionoscloud/models/locations.rb +2 -2
  220. data/lib/ionoscloud/models/nat_gateway.rb +271 -0
  221. data/lib/ionoscloud/models/nat_gateway_entities.rb +227 -0
  222. data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +236 -0
  223. data/lib/ionoscloud/models/nat_gateway_properties.rb +253 -0
  224. data/lib/ionoscloud/models/nat_gateway_put.rb +253 -0
  225. data/lib/ionoscloud/models/nat_gateway_rule.rb +262 -0
  226. data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +293 -0
  227. data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +39 -0
  228. data/lib/ionoscloud/models/nat_gateway_rule_put.rb +253 -0
  229. data/lib/ionoscloud/models/nat_gateway_rule_type.rb +36 -0
  230. data/lib/ionoscloud/models/nat_gateway_rules.rb +251 -0
  231. data/lib/ionoscloud/models/nat_gateways.rb +280 -0
  232. data/lib/ionoscloud/models/network_load_balancer.rb +271 -0
  233. data/lib/ionoscloud/models/network_load_balancer_entities.rb +227 -0
  234. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +262 -0
  235. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +249 -0
  236. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +356 -0
  237. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +253 -0
  238. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +263 -0
  239. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +239 -0
  240. data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +280 -0
  241. data/lib/ionoscloud/models/network_load_balancer_properties.rb +278 -0
  242. data/lib/ionoscloud/models/network_load_balancer_put.rb +253 -0
  243. data/lib/ionoscloud/models/network_load_balancers.rb +280 -0
  244. data/lib/ionoscloud/models/nic.rb +2 -2
  245. data/lib/ionoscloud/models/nic_entities.rb +12 -3
  246. data/lib/ionoscloud/models/nic_properties.rb +64 -10
  247. data/lib/ionoscloud/models/nic_put.rb +253 -0
  248. data/lib/ionoscloud/models/nics.rb +2 -2
  249. data/lib/ionoscloud/models/no_state_meta_data.rb +2 -2
  250. data/lib/ionoscloud/models/pagination_links.rb +2 -2
  251. data/lib/ionoscloud/models/peer.rb +2 -2
  252. data/lib/ionoscloud/models/private_cross_connect.rb +2 -2
  253. data/lib/ionoscloud/models/private_cross_connect_properties.rb +3 -3
  254. data/lib/ionoscloud/models/private_cross_connects.rb +2 -2
  255. data/lib/ionoscloud/models/{kubernetes_config_properties.rb → remote_console_url.rb} +13 -13
  256. data/lib/ionoscloud/models/request.rb +2 -2
  257. data/lib/ionoscloud/models/request_metadata.rb +2 -2
  258. data/lib/ionoscloud/models/request_properties.rb +2 -2
  259. data/lib/ionoscloud/models/request_status.rb +2 -2
  260. data/lib/ionoscloud/models/request_status_metadata.rb +2 -2
  261. data/lib/ionoscloud/models/request_target.rb +2 -2
  262. data/lib/ionoscloud/models/requests.rb +2 -2
  263. data/lib/ionoscloud/models/resource.rb +2 -2
  264. data/lib/ionoscloud/models/resource_entities.rb +2 -2
  265. data/lib/ionoscloud/models/resource_groups.rb +2 -2
  266. data/lib/ionoscloud/models/resource_limits.rb +81 -6
  267. data/lib/ionoscloud/models/resource_properties.rb +3 -3
  268. data/lib/ionoscloud/models/resource_reference.rb +2 -2
  269. data/lib/ionoscloud/models/resources.rb +2 -2
  270. data/lib/ionoscloud/models/resources_users.rb +2 -2
  271. data/lib/ionoscloud/models/s3_bucket.rb +3 -3
  272. data/lib/ionoscloud/models/s3_key.rb +2 -2
  273. data/lib/ionoscloud/models/s3_key_metadata.rb +2 -2
  274. data/lib/ionoscloud/models/s3_key_properties.rb +2 -2
  275. data/lib/ionoscloud/models/s3_keys.rb +2 -2
  276. data/lib/ionoscloud/models/s3_object_storage_sso.rb +2 -2
  277. data/lib/ionoscloud/models/server.rb +2 -2
  278. data/lib/ionoscloud/models/server_entities.rb +2 -2
  279. data/lib/ionoscloud/models/server_properties.rb +27 -7
  280. data/lib/ionoscloud/models/servers.rb +2 -2
  281. data/lib/ionoscloud/models/snapshot.rb +2 -2
  282. data/lib/ionoscloud/models/snapshot_properties.rb +2 -2
  283. data/lib/ionoscloud/models/snapshots.rb +2 -2
  284. data/lib/ionoscloud/models/target_port_range.rb +229 -0
  285. data/lib/ionoscloud/models/template.rb +262 -0
  286. data/lib/ionoscloud/models/template_properties.rb +269 -0
  287. data/lib/ionoscloud/models/templates.rb +251 -0
  288. data/lib/ionoscloud/models/token.rb +219 -0
  289. data/lib/ionoscloud/models/type.rb +10 -2
  290. data/lib/ionoscloud/models/user.rb +2 -2
  291. data/lib/ionoscloud/models/user_metadata.rb +2 -2
  292. data/lib/ionoscloud/models/user_post.rb +2 -2
  293. data/lib/ionoscloud/models/user_properties.rb +2 -2
  294. data/lib/ionoscloud/models/user_properties_post.rb +2 -2
  295. data/lib/ionoscloud/models/user_properties_put.rb +2 -2
  296. data/lib/ionoscloud/models/user_put.rb +2 -2
  297. data/lib/ionoscloud/models/users.rb +2 -2
  298. data/lib/ionoscloud/models/users_entities.rb +2 -2
  299. data/lib/ionoscloud/models/volume.rb +2 -2
  300. data/lib/ionoscloud/models/volume_properties.rb +16 -6
  301. data/lib/ionoscloud/models/volumes.rb +2 -2
  302. data/lib/ionoscloud/version.rb +3 -3
  303. data/lib/ionoscloud.rb +60 -18
  304. data/spec/api/_api_spec.rb +5 -5
  305. data/spec/api/backup_units_api_spec.rb +140 -0
  306. data/spec/api/contract_resources_api_spec.rb +49 -0
  307. data/spec/api/data_centers_api_spec.rb +128 -0
  308. data/spec/api/firewall_rules_api_spec.rb +146 -0
  309. data/spec/api/flow_logs_api_spec.rb +140 -0
  310. data/spec/api/images_api_spec.rb +111 -0
  311. data/spec/api/ip_blocks_api_spec.rb +27 -27
  312. data/spec/api/kubernetes_api_spec.rb +55 -67
  313. data/spec/api/labels_api_spec.rb +474 -0
  314. data/spec/api/lans_api_spec.rb +186 -0
  315. data/spec/api/load_balancers_api_spec.rb +201 -0
  316. data/spec/api/locations_api_spec.rb +80 -0
  317. data/spec/api/nat_gateways_api_spec.rb +334 -0
  318. data/spec/api/network_interfaces_api_spec.rb +140 -0
  319. data/spec/api/network_load_balancers_api_spec.rb +340 -0
  320. data/spec/api/private_cross_connects_api_spec.rb +110 -0
  321. data/spec/api/{request_api_spec.rb → requests_api_spec.rb} +19 -19
  322. data/spec/api/servers_api_spec.rb +401 -0
  323. data/spec/api/snapshots_api_spec.rb +111 -0
  324. data/spec/api/templates_api_spec.rb +60 -0
  325. data/spec/api/user_management_api_spec.rb +81 -174
  326. data/spec/api/user_s3_keys_api_spec.rb +128 -0
  327. data/spec/api/volumes_api_spec.rb +171 -0
  328. data/spec/api_client_spec.rb +2 -2
  329. data/spec/configuration_spec.rb +5 -5
  330. data/spec/models/attached_volumes_spec.rb +2 -2
  331. data/spec/models/backup_unit_properties_spec.rb +2 -2
  332. data/spec/models/backup_unit_spec.rb +2 -2
  333. data/spec/models/backup_unit_sso_spec.rb +2 -2
  334. data/spec/models/backup_units_spec.rb +2 -2
  335. data/spec/models/balanced_nics_spec.rb +2 -2
  336. data/spec/models/cdroms_spec.rb +2 -2
  337. data/spec/models/connectable_datacenter_spec.rb +2 -2
  338. data/spec/models/contract_properties_spec.rb +2 -2
  339. data/spec/models/contract_spec.rb +2 -2
  340. data/spec/models/contracts_spec.rb +52 -0
  341. data/spec/models/cpu_architecture_properties_spec.rb +52 -0
  342. data/spec/models/data_center_entities_spec.rb +14 -2
  343. data/spec/models/datacenter_element_metadata_spec.rb +3 -3
  344. data/spec/models/datacenter_properties_spec.rb +8 -2
  345. data/spec/models/datacenter_spec.rb +2 -2
  346. data/spec/models/datacenters_spec.rb +2 -2
  347. data/spec/models/error_message_spec.rb +2 -2
  348. data/spec/models/error_spec.rb +2 -2
  349. data/spec/models/firewall_rule_spec.rb +2 -2
  350. data/spec/models/firewall_rules_spec.rb +2 -2
  351. data/spec/models/firewallrule_properties_spec.rb +12 -2
  352. data/spec/models/flow_log_properties_spec.rb +60 -0
  353. data/spec/models/flow_log_put_spec.rb +52 -0
  354. data/spec/models/flow_log_spec.rb +58 -0
  355. data/spec/models/flow_logs_spec.rb +70 -0
  356. data/spec/models/group_entities_spec.rb +2 -2
  357. data/spec/models/group_members_spec.rb +2 -2
  358. data/spec/models/group_properties_spec.rb +20 -2
  359. data/spec/models/group_share_properties_spec.rb +2 -2
  360. data/spec/models/group_share_spec.rb +2 -2
  361. data/spec/models/group_shares_spec.rb +2 -2
  362. data/spec/models/group_spec.rb +2 -2
  363. data/spec/models/group_users_spec.rb +2 -2
  364. data/spec/models/groups_spec.rb +2 -2
  365. data/spec/models/image_properties_spec.rb +2 -2
  366. data/spec/models/image_spec.rb +2 -2
  367. data/spec/models/images_spec.rb +2 -2
  368. data/spec/models/info_spec.rb +2 -2
  369. data/spec/models/ip_block_properties_spec.rb +2 -2
  370. data/spec/models/ip_block_spec.rb +2 -2
  371. data/spec/models/ip_blocks_spec.rb +2 -2
  372. data/spec/models/ip_consumer_spec.rb +2 -2
  373. data/spec/models/ip_failover_spec.rb +2 -2
  374. data/spec/models/kubernetes_auto_scaling_spec.rb +2 -2
  375. data/spec/models/kubernetes_cluster_entities_spec.rb +2 -2
  376. data/spec/models/kubernetes_cluster_for_post_spec.rb +2 -2
  377. data/spec/models/kubernetes_cluster_for_put_spec.rb +2 -2
  378. data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +2 -2
  379. data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +2 -2
  380. data/spec/models/kubernetes_cluster_properties_spec.rb +2 -2
  381. data/spec/models/kubernetes_cluster_spec.rb +2 -2
  382. data/spec/models/kubernetes_clusters_spec.rb +2 -2
  383. data/spec/models/kubernetes_maintenance_window_spec.rb +2 -2
  384. data/spec/models/kubernetes_node_metadata_spec.rb +3 -3
  385. data/spec/models/kubernetes_node_pool_for_post_spec.rb +2 -2
  386. data/spec/models/kubernetes_node_pool_for_put_spec.rb +2 -2
  387. data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +40 -0
  388. data/spec/models/kubernetes_node_pool_lan_spec.rb +14 -2
  389. data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +2 -2
  390. data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +2 -2
  391. data/spec/models/kubernetes_node_pool_properties_spec.rb +2 -2
  392. data/spec/models/kubernetes_node_pool_spec.rb +2 -2
  393. data/spec/models/kubernetes_node_pools_spec.rb +2 -2
  394. data/spec/models/kubernetes_node_properties_spec.rb +2 -2
  395. data/spec/models/kubernetes_node_spec.rb +2 -2
  396. data/spec/models/kubernetes_nodes_spec.rb +2 -2
  397. data/spec/models/label_properties_spec.rb +2 -2
  398. data/spec/models/label_resource_properties_spec.rb +2 -2
  399. data/spec/models/label_resource_spec.rb +2 -2
  400. data/spec/models/label_resources_spec.rb +2 -2
  401. data/spec/models/label_spec.rb +2 -2
  402. data/spec/models/labels_spec.rb +2 -2
  403. data/spec/models/lan_entities_spec.rb +2 -2
  404. data/spec/models/lan_nics_spec.rb +2 -2
  405. data/spec/models/lan_post_spec.rb +2 -2
  406. data/spec/models/lan_properties_post_spec.rb +2 -2
  407. data/spec/models/lan_properties_spec.rb +2 -2
  408. data/spec/models/lan_spec.rb +2 -2
  409. data/spec/models/lans_spec.rb +2 -2
  410. data/spec/models/loadbalancer_entities_spec.rb +2 -2
  411. data/spec/models/loadbalancer_properties_spec.rb +2 -2
  412. data/spec/models/loadbalancer_spec.rb +2 -2
  413. data/spec/models/loadbalancers_spec.rb +2 -2
  414. data/spec/models/location_properties_spec.rb +8 -2
  415. data/spec/models/location_spec.rb +2 -2
  416. data/spec/models/locations_spec.rb +2 -2
  417. data/spec/models/nat_gateway_entities_spec.rb +40 -0
  418. data/spec/models/nat_gateway_lan_properties_spec.rb +40 -0
  419. data/spec/models/nat_gateway_properties_spec.rb +46 -0
  420. data/spec/models/nat_gateway_put_spec.rb +52 -0
  421. data/spec/models/nat_gateway_rule_properties_spec.rb +70 -0
  422. data/spec/models/nat_gateway_rule_protocol_spec.rb +28 -0
  423. data/spec/models/nat_gateway_rule_put_spec.rb +52 -0
  424. data/spec/models/nat_gateway_rule_spec.rb +58 -0
  425. data/spec/models/nat_gateway_rule_type_spec.rb +28 -0
  426. data/spec/models/nat_gateway_rules_spec.rb +52 -0
  427. data/spec/models/nat_gateway_spec.rb +64 -0
  428. data/spec/models/nat_gateways_spec.rb +70 -0
  429. data/spec/models/network_load_balancer_entities_spec.rb +40 -0
  430. data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +52 -0
  431. data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +78 -0
  432. data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +52 -0
  433. data/spec/models/network_load_balancer_forwarding_rule_spec.rb +58 -0
  434. data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +46 -0
  435. data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +52 -0
  436. data/spec/models/network_load_balancer_forwarding_rules_spec.rb +70 -0
  437. data/spec/models/network_load_balancer_properties_spec.rb +58 -0
  438. data/spec/models/network_load_balancer_put_spec.rb +52 -0
  439. data/spec/models/network_load_balancer_spec.rb +64 -0
  440. data/spec/models/network_load_balancers_spec.rb +70 -0
  441. data/spec/models/nic_entities_spec.rb +8 -2
  442. data/spec/models/nic_properties_spec.rb +19 -3
  443. data/spec/models/nic_put_spec.rb +52 -0
  444. data/spec/models/nic_spec.rb +2 -2
  445. data/spec/models/nics_spec.rb +2 -2
  446. data/spec/models/no_state_meta_data_spec.rb +2 -2
  447. data/spec/models/pagination_links_spec.rb +2 -2
  448. data/spec/models/peer_spec.rb +2 -2
  449. data/spec/models/private_cross_connect_properties_spec.rb +2 -2
  450. data/spec/models/private_cross_connect_spec.rb +2 -2
  451. data/spec/models/private_cross_connects_spec.rb +2 -2
  452. data/spec/models/remote_console_url_spec.rb +34 -0
  453. data/spec/models/request_metadata_spec.rb +2 -2
  454. data/spec/models/request_properties_spec.rb +2 -2
  455. data/spec/models/request_spec.rb +2 -2
  456. data/spec/models/request_status_metadata_spec.rb +2 -2
  457. data/spec/models/request_status_spec.rb +2 -2
  458. data/spec/models/request_target_spec.rb +2 -2
  459. data/spec/models/requests_spec.rb +2 -2
  460. data/spec/models/resource_entities_spec.rb +2 -2
  461. data/spec/models/resource_groups_spec.rb +2 -2
  462. data/spec/models/resource_limits_spec.rb +32 -2
  463. data/spec/models/resource_properties_spec.rb +2 -2
  464. data/spec/models/resource_reference_spec.rb +2 -2
  465. data/spec/models/resource_spec.rb +2 -2
  466. data/spec/models/resources_spec.rb +2 -2
  467. data/spec/models/resources_users_spec.rb +2 -2
  468. data/spec/models/s3_bucket_spec.rb +2 -2
  469. data/spec/models/s3_key_metadata_spec.rb +2 -2
  470. data/spec/models/s3_key_properties_spec.rb +2 -2
  471. data/spec/models/s3_key_spec.rb +2 -2
  472. data/spec/models/s3_keys_spec.rb +2 -2
  473. data/spec/models/s3_object_storage_sso_spec.rb +2 -2
  474. data/spec/models/server_entities_spec.rb +2 -2
  475. data/spec/models/server_properties_spec.rb +14 -2
  476. data/spec/models/server_spec.rb +2 -2
  477. data/spec/models/servers_spec.rb +2 -2
  478. data/spec/models/snapshot_properties_spec.rb +2 -2
  479. data/spec/models/snapshot_spec.rb +2 -2
  480. data/spec/models/snapshots_spec.rb +2 -2
  481. data/spec/models/target_port_range_spec.rb +40 -0
  482. data/spec/models/template_properties_spec.rb +52 -0
  483. data/spec/models/template_spec.rb +58 -0
  484. data/spec/models/templates_spec.rb +52 -0
  485. data/spec/models/token_spec.rb +34 -0
  486. data/spec/models/type_spec.rb +2 -2
  487. data/spec/models/user_metadata_spec.rb +2 -2
  488. data/spec/models/user_post_spec.rb +2 -2
  489. data/spec/models/user_properties_post_spec.rb +2 -2
  490. data/spec/models/user_properties_put_spec.rb +2 -2
  491. data/spec/models/user_properties_spec.rb +2 -2
  492. data/spec/models/user_put_spec.rb +2 -2
  493. data/spec/models/user_spec.rb +2 -2
  494. data/spec/models/users_entities_spec.rb +2 -2
  495. data/spec/models/users_spec.rb +2 -2
  496. data/spec/models/volume_properties_spec.rb +8 -2
  497. data/spec/models/volume_spec.rb +2 -2
  498. data/spec/models/volumes_spec.rb +2 -2
  499. data/spec/spec_helper.rb +2 -2
  500. metadata +246 -80
  501. data/Gemfile.lock +0 -68
  502. data/docs/api/BackupUnitApi.md +0 -595
  503. data/docs/api/ContractApi.md +0 -89
  504. data/docs/api/DataCenterApi.md +0 -517
  505. data/docs/api/ImageApi.md +0 -429
  506. data/docs/api/LabelApi.md +0 -2355
  507. data/docs/api/LanApi.md +0 -795
  508. data/docs/api/LoadBalancerApi.md +0 -883
  509. data/docs/api/LocationApi.md +0 -259
  510. data/docs/api/NicApi.md +0 -1087
  511. data/docs/api/PrivateCrossConnectApi.md +0 -427
  512. data/docs/api/ServerApi.md +0 -1573
  513. data/docs/api/SnapshotApi.md +0 -429
  514. data/docs/api/VolumeApi.md +0 -711
  515. data/docs/models/KubernetesConfig.md +0 -24
  516. data/docs/models/KubernetesConfigProperties.md +0 -18
  517. data/lib/ionoscloud/api/contract_api.rb +0 -96
  518. data/lib/ionoscloud/api/data_center_api.rb +0 -532
  519. data/lib/ionoscloud/api/nic_api.rb +0 -1222
  520. data/lib/ionoscloud/api/server_api.rb +0 -1679
  521. data/lib/test_driver.rb +0 -104
  522. data/spec/api/backup_unit_api_spec.rb +0 -140
  523. data/spec/api/contract_api_spec.rb +0 -49
  524. data/spec/api/data_center_api_spec.rb +0 -128
  525. data/spec/api/image_api_spec.rb +0 -111
  526. data/spec/api/label_api_spec.rb +0 -480
  527. data/spec/api/lan_api_spec.rb +0 -186
  528. data/spec/api/load_balancer_api_spec.rb +0 -203
  529. data/spec/api/location_api_spec.rb +0 -80
  530. data/spec/api/nic_api_spec.rb +0 -251
  531. data/spec/api/private_cross_connect_api_spec.rb +0 -110
  532. data/spec/api/server_api_spec.rb +0 -337
  533. data/spec/api/snapshot_api_spec.rb +0 -111
  534. data/spec/api/volume_api_spec.rb +0 -171
  535. data/spec/models/kubernetes_config_properties_spec.rb +0 -34
  536. data/spec/models/kubernetes_config_spec.rb +0 -56
@@ -1,1573 +0,0 @@
1
- # ServerApi
2
-
3
- All URIs are relative to *https://api.ionos.com/cloudapi/v5*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**datacenters_servers_cdroms_delete**](ServerApi.md#datacenters_servers_cdroms_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Detach a CD-ROM |
8
- | [**datacenters_servers_cdroms_find_by_id**](ServerApi.md#datacenters_servers_cdroms_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Retrieve an attached CD-ROM |
9
- | [**datacenters_servers_cdroms_get**](ServerApi.md#datacenters_servers_cdroms_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/cdroms | List attached CD-ROMs |
10
- | [**datacenters_servers_cdroms_post**](ServerApi.md#datacenters_servers_cdroms_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/cdroms | Attach a CD-ROM |
11
- | [**datacenters_servers_delete**](ServerApi.md#datacenters_servers_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId} | Delete a Server |
12
- | [**datacenters_servers_find_by_id**](ServerApi.md#datacenters_servers_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId} | Retrieve a Server |
13
- | [**datacenters_servers_get**](ServerApi.md#datacenters_servers_get) | **GET** /datacenters/{datacenterId}/servers | List Servers |
14
- | [**datacenters_servers_patch**](ServerApi.md#datacenters_servers_patch) | **PATCH** /datacenters/{datacenterId}/servers/{serverId} | Partially modify a Server |
15
- | [**datacenters_servers_post**](ServerApi.md#datacenters_servers_post) | **POST** /datacenters/{datacenterId}/servers | Create a Server |
16
- | [**datacenters_servers_put**](ServerApi.md#datacenters_servers_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId} | Modify a Server |
17
- | [**datacenters_servers_reboot_post**](ServerApi.md#datacenters_servers_reboot_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/reboot | Reboot a Server |
18
- | [**datacenters_servers_start_post**](ServerApi.md#datacenters_servers_start_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/start | Start a Server |
19
- | [**datacenters_servers_stop_post**](ServerApi.md#datacenters_servers_stop_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/stop | Stop a Server |
20
- | [**datacenters_servers_upgrade_post**](ServerApi.md#datacenters_servers_upgrade_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/upgrade | Upgrade a Server |
21
- | [**datacenters_servers_volumes_delete**](ServerApi.md#datacenters_servers_volumes_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Detach a volume |
22
- | [**datacenters_servers_volumes_find_by_id**](ServerApi.md#datacenters_servers_volumes_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Retrieve an attached volume |
23
- | [**datacenters_servers_volumes_get**](ServerApi.md#datacenters_servers_volumes_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes | List Attached Volumes |
24
- | [**datacenters_servers_volumes_post**](ServerApi.md#datacenters_servers_volumes_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/volumes | Attach a volume |
25
-
26
-
27
- ## datacenters_servers_cdroms_delete
28
-
29
- > Object datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, opts)
30
-
31
- Detach a CD-ROM
32
-
33
- This will detach a CD-ROM from the server
34
-
35
- ### Examples
36
-
37
- ```ruby
38
- require 'time'
39
- require 'ionoscloud'
40
- # setup authorization
41
- Ionoscloud.configure do |config|
42
- # Configure HTTP basic authorization: Basic Authentication
43
- config.username = 'YOUR USERNAME'
44
- config.password = 'YOUR PASSWORD'
45
-
46
- # Configure API key authorization: Token Authentication
47
- config.api_key['Authorization'] = 'YOUR API KEY'
48
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
49
- # config.api_key_prefix['Authorization'] = 'Bearer'
50
- end
51
-
52
- api_instance = Ionoscloud::ServerApi.new
53
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
54
- server_id = 'server_id_example' # String | The unique ID of the Server
55
- cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM
56
- opts = {
57
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
58
- 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
59
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
60
- }
61
-
62
- begin
63
- # Detach a CD-ROM
64
- result = api_instance.datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, opts)
65
- p result
66
- rescue Ionoscloud::ApiError => e
67
- puts "Error when calling ServerApi->datacenters_servers_cdroms_delete: #{e}"
68
- end
69
- ```
70
-
71
- #### Using the datacenters_servers_cdroms_delete_with_http_info variant
72
-
73
- This returns an Array which contains the response data, status code and headers.
74
-
75
- > <Array(Object, Integer, Hash)> datacenters_servers_cdroms_delete_with_http_info(datacenter_id, server_id, cdrom_id, opts)
76
-
77
- ```ruby
78
- begin
79
- # Detach a CD-ROM
80
- data, status_code, headers = api_instance.datacenters_servers_cdroms_delete_with_http_info(datacenter_id, server_id, cdrom_id, opts)
81
- p status_code # => 2xx
82
- p headers # => { ... }
83
- p data # => Object
84
- rescue Ionoscloud::ApiError => e
85
- puts "Error when calling ServerApi->datacenters_servers_cdroms_delete_with_http_info: #{e}"
86
- end
87
- ```
88
-
89
- ### Parameters
90
-
91
- | Name | Type | Description | Notes |
92
- | ---- | ---- | ----------- | ----- |
93
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
94
- | **server_id** | **String** | The unique ID of the Server | |
95
- | **cdrom_id** | **String** | The unique ID of the CD-ROM | |
96
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
97
- | **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] |
98
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
99
-
100
- ### Return type
101
-
102
- **Object**
103
-
104
- ### Authorization
105
-
106
- Basic Authentication, Token Authentication
107
-
108
- ### HTTP request headers
109
-
110
- - **Content-Type**: Not defined
111
- - **Accept**: application/json
112
-
113
-
114
- ## datacenters_servers_cdroms_find_by_id
115
-
116
- > <Image> datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, opts)
117
-
118
- Retrieve an attached CD-ROM
119
-
120
- You can retrieve a specific CD-ROM attached to the server
121
-
122
- ### Examples
123
-
124
- ```ruby
125
- require 'time'
126
- require 'ionoscloud'
127
- # setup authorization
128
- Ionoscloud.configure do |config|
129
- # Configure HTTP basic authorization: Basic Authentication
130
- config.username = 'YOUR USERNAME'
131
- config.password = 'YOUR PASSWORD'
132
-
133
- # Configure API key authorization: Token Authentication
134
- config.api_key['Authorization'] = 'YOUR API KEY'
135
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
136
- # config.api_key_prefix['Authorization'] = 'Bearer'
137
- end
138
-
139
- api_instance = Ionoscloud::ServerApi.new
140
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
141
- server_id = 'server_id_example' # String | The unique ID of the Server
142
- cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM
143
- opts = {
144
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
145
- 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
146
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
147
- }
148
-
149
- begin
150
- # Retrieve an attached CD-ROM
151
- result = api_instance.datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, opts)
152
- p result
153
- rescue Ionoscloud::ApiError => e
154
- puts "Error when calling ServerApi->datacenters_servers_cdroms_find_by_id: #{e}"
155
- end
156
- ```
157
-
158
- #### Using the datacenters_servers_cdroms_find_by_id_with_http_info variant
159
-
160
- This returns an Array which contains the response data, status code and headers.
161
-
162
- > <Array(<Image>, Integer, Hash)> datacenters_servers_cdroms_find_by_id_with_http_info(datacenter_id, server_id, cdrom_id, opts)
163
-
164
- ```ruby
165
- begin
166
- # Retrieve an attached CD-ROM
167
- data, status_code, headers = api_instance.datacenters_servers_cdroms_find_by_id_with_http_info(datacenter_id, server_id, cdrom_id, opts)
168
- p status_code # => 2xx
169
- p headers # => { ... }
170
- p data # => <Image>
171
- rescue Ionoscloud::ApiError => e
172
- puts "Error when calling ServerApi->datacenters_servers_cdroms_find_by_id_with_http_info: #{e}"
173
- end
174
- ```
175
-
176
- ### Parameters
177
-
178
- | Name | Type | Description | Notes |
179
- | ---- | ---- | ----------- | ----- |
180
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
181
- | **server_id** | **String** | The unique ID of the Server | |
182
- | **cdrom_id** | **String** | The unique ID of the CD-ROM | |
183
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
184
- | **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] |
185
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
186
-
187
- ### Return type
188
-
189
- [**Image**](Image.md)
190
-
191
- ### Authorization
192
-
193
- Basic Authentication, Token Authentication
194
-
195
- ### HTTP request headers
196
-
197
- - **Content-Type**: Not defined
198
- - **Accept**: application/json
199
-
200
-
201
- ## datacenters_servers_cdroms_get
202
-
203
- > <Cdroms> datacenters_servers_cdroms_get(datacenter_id, server_id, opts)
204
-
205
- List attached CD-ROMs
206
-
207
- You can retrieve a list of CD-ROMs attached to the server.
208
-
209
- ### Examples
210
-
211
- ```ruby
212
- require 'time'
213
- require 'ionoscloud'
214
- # setup authorization
215
- Ionoscloud.configure do |config|
216
- # Configure HTTP basic authorization: Basic Authentication
217
- config.username = 'YOUR USERNAME'
218
- config.password = 'YOUR PASSWORD'
219
-
220
- # Configure API key authorization: Token Authentication
221
- config.api_key['Authorization'] = 'YOUR API KEY'
222
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
223
- # config.api_key_prefix['Authorization'] = 'Bearer'
224
- end
225
-
226
- api_instance = Ionoscloud::ServerApi.new
227
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
228
- server_id = 'server_id_example' # String | The unique ID of the Server
229
- opts = {
230
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
231
- 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
232
- x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
233
- offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
234
- limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
235
- }
236
-
237
- begin
238
- # List attached CD-ROMs
239
- result = api_instance.datacenters_servers_cdroms_get(datacenter_id, server_id, opts)
240
- p result
241
- rescue Ionoscloud::ApiError => e
242
- puts "Error when calling ServerApi->datacenters_servers_cdroms_get: #{e}"
243
- end
244
- ```
245
-
246
- #### Using the datacenters_servers_cdroms_get_with_http_info variant
247
-
248
- This returns an Array which contains the response data, status code and headers.
249
-
250
- > <Array(<Cdroms>, Integer, Hash)> datacenters_servers_cdroms_get_with_http_info(datacenter_id, server_id, opts)
251
-
252
- ```ruby
253
- begin
254
- # List attached CD-ROMs
255
- data, status_code, headers = api_instance.datacenters_servers_cdroms_get_with_http_info(datacenter_id, server_id, opts)
256
- p status_code # => 2xx
257
- p headers # => { ... }
258
- p data # => <Cdroms>
259
- rescue Ionoscloud::ApiError => e
260
- puts "Error when calling ServerApi->datacenters_servers_cdroms_get_with_http_info: #{e}"
261
- end
262
- ```
263
-
264
- ### Parameters
265
-
266
- | Name | Type | Description | Notes |
267
- | ---- | ---- | ----------- | ----- |
268
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
269
- | **server_id** | **String** | The unique ID of the Server | |
270
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
271
- | **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] |
272
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
273
- | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) | [optional][default to 0] |
274
- | **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 1000] |
275
-
276
- ### Return type
277
-
278
- [**Cdroms**](Cdroms.md)
279
-
280
- ### Authorization
281
-
282
- Basic Authentication, Token Authentication
283
-
284
- ### HTTP request headers
285
-
286
- - **Content-Type**: Not defined
287
- - **Accept**: application/json
288
-
289
-
290
- ## datacenters_servers_cdroms_post
291
-
292
- > <Image> datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, opts)
293
-
294
- Attach a CD-ROM
295
-
296
- You can attach a CD-ROM to an existing server. You can attach up to 2 CD-ROMs to one server.
297
-
298
- ### Examples
299
-
300
- ```ruby
301
- require 'time'
302
- require 'ionoscloud'
303
- # setup authorization
304
- Ionoscloud.configure do |config|
305
- # Configure HTTP basic authorization: Basic Authentication
306
- config.username = 'YOUR USERNAME'
307
- config.password = 'YOUR PASSWORD'
308
-
309
- # Configure API key authorization: Token Authentication
310
- config.api_key['Authorization'] = 'YOUR API KEY'
311
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
312
- # config.api_key_prefix['Authorization'] = 'Bearer'
313
- end
314
-
315
- api_instance = Ionoscloud::ServerApi.new
316
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
317
- server_id = 'server_id_example' # String | The unique ID of the Server
318
- cdrom = Ionoscloud::Image.new({properties: Ionoscloud::ImageProperties.new({licence_type: 'UNKNOWN'})}) # Image | CD-ROM to be attached
319
- opts = {
320
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
321
- 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
322
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
323
- }
324
-
325
- begin
326
- # Attach a CD-ROM
327
- result = api_instance.datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, opts)
328
- p result
329
- rescue Ionoscloud::ApiError => e
330
- puts "Error when calling ServerApi->datacenters_servers_cdroms_post: #{e}"
331
- end
332
- ```
333
-
334
- #### Using the datacenters_servers_cdroms_post_with_http_info variant
335
-
336
- This returns an Array which contains the response data, status code and headers.
337
-
338
- > <Array(<Image>, Integer, Hash)> datacenters_servers_cdroms_post_with_http_info(datacenter_id, server_id, cdrom, opts)
339
-
340
- ```ruby
341
- begin
342
- # Attach a CD-ROM
343
- data, status_code, headers = api_instance.datacenters_servers_cdroms_post_with_http_info(datacenter_id, server_id, cdrom, opts)
344
- p status_code # => 2xx
345
- p headers # => { ... }
346
- p data # => <Image>
347
- rescue Ionoscloud::ApiError => e
348
- puts "Error when calling ServerApi->datacenters_servers_cdroms_post_with_http_info: #{e}"
349
- end
350
- ```
351
-
352
- ### Parameters
353
-
354
- | Name | Type | Description | Notes |
355
- | ---- | ---- | ----------- | ----- |
356
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
357
- | **server_id** | **String** | The unique ID of the Server | |
358
- | **cdrom** | [**Image**](Image.md) | CD-ROM to be attached | |
359
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
360
- | **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] |
361
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
362
-
363
- ### Return type
364
-
365
- [**Image**](Image.md)
366
-
367
- ### Authorization
368
-
369
- Basic Authentication, Token Authentication
370
-
371
- ### HTTP request headers
372
-
373
- - **Content-Type**: application/json
374
- - **Accept**: application/json
375
-
376
-
377
- ## datacenters_servers_delete
378
-
379
- > Object datacenters_servers_delete(datacenter_id, server_id, opts)
380
-
381
- Delete a Server
382
-
383
- This will remove a server from your datacenter; however, it will not remove the storage volumes attached to the server. You will need to make a separate API call to perform that action
384
-
385
- ### Examples
386
-
387
- ```ruby
388
- require 'time'
389
- require 'ionoscloud'
390
- # setup authorization
391
- Ionoscloud.configure do |config|
392
- # Configure HTTP basic authorization: Basic Authentication
393
- config.username = 'YOUR USERNAME'
394
- config.password = 'YOUR PASSWORD'
395
-
396
- # Configure API key authorization: Token Authentication
397
- config.api_key['Authorization'] = 'YOUR API KEY'
398
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
399
- # config.api_key_prefix['Authorization'] = 'Bearer'
400
- end
401
-
402
- api_instance = Ionoscloud::ServerApi.new
403
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
404
- server_id = 'server_id_example' # String | The unique ID of the Server
405
- opts = {
406
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
407
- 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
408
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
409
- }
410
-
411
- begin
412
- # Delete a Server
413
- result = api_instance.datacenters_servers_delete(datacenter_id, server_id, opts)
414
- p result
415
- rescue Ionoscloud::ApiError => e
416
- puts "Error when calling ServerApi->datacenters_servers_delete: #{e}"
417
- end
418
- ```
419
-
420
- #### Using the datacenters_servers_delete_with_http_info variant
421
-
422
- This returns an Array which contains the response data, status code and headers.
423
-
424
- > <Array(Object, Integer, Hash)> datacenters_servers_delete_with_http_info(datacenter_id, server_id, opts)
425
-
426
- ```ruby
427
- begin
428
- # Delete a Server
429
- data, status_code, headers = api_instance.datacenters_servers_delete_with_http_info(datacenter_id, server_id, opts)
430
- p status_code # => 2xx
431
- p headers # => { ... }
432
- p data # => Object
433
- rescue Ionoscloud::ApiError => e
434
- puts "Error when calling ServerApi->datacenters_servers_delete_with_http_info: #{e}"
435
- end
436
- ```
437
-
438
- ### Parameters
439
-
440
- | Name | Type | Description | Notes |
441
- | ---- | ---- | ----------- | ----- |
442
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
443
- | **server_id** | **String** | The unique ID of the Server | |
444
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
445
- | **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] |
446
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
447
-
448
- ### Return type
449
-
450
- **Object**
451
-
452
- ### Authorization
453
-
454
- Basic Authentication, Token Authentication
455
-
456
- ### HTTP request headers
457
-
458
- - **Content-Type**: Not defined
459
- - **Accept**: application/json
460
-
461
-
462
- ## datacenters_servers_find_by_id
463
-
464
- > <Server> datacenters_servers_find_by_id(datacenter_id, server_id, opts)
465
-
466
- Retrieve a Server
467
-
468
- Returns information about a server such as its configuration, provisioning status, etc.
469
-
470
- ### Examples
471
-
472
- ```ruby
473
- require 'time'
474
- require 'ionoscloud'
475
- # setup authorization
476
- Ionoscloud.configure do |config|
477
- # Configure HTTP basic authorization: Basic Authentication
478
- config.username = 'YOUR USERNAME'
479
- config.password = 'YOUR PASSWORD'
480
-
481
- # Configure API key authorization: Token Authentication
482
- config.api_key['Authorization'] = 'YOUR API KEY'
483
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
484
- # config.api_key_prefix['Authorization'] = 'Bearer'
485
- end
486
-
487
- api_instance = Ionoscloud::ServerApi.new
488
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
489
- server_id = 'server_id_example' # String | The unique ID of the Server
490
- opts = {
491
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
492
- 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
493
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
494
- }
495
-
496
- begin
497
- # Retrieve a Server
498
- result = api_instance.datacenters_servers_find_by_id(datacenter_id, server_id, opts)
499
- p result
500
- rescue Ionoscloud::ApiError => e
501
- puts "Error when calling ServerApi->datacenters_servers_find_by_id: #{e}"
502
- end
503
- ```
504
-
505
- #### Using the datacenters_servers_find_by_id_with_http_info variant
506
-
507
- This returns an Array which contains the response data, status code and headers.
508
-
509
- > <Array(<Server>, Integer, Hash)> datacenters_servers_find_by_id_with_http_info(datacenter_id, server_id, opts)
510
-
511
- ```ruby
512
- begin
513
- # Retrieve a Server
514
- data, status_code, headers = api_instance.datacenters_servers_find_by_id_with_http_info(datacenter_id, server_id, opts)
515
- p status_code # => 2xx
516
- p headers # => { ... }
517
- p data # => <Server>
518
- rescue Ionoscloud::ApiError => e
519
- puts "Error when calling ServerApi->datacenters_servers_find_by_id_with_http_info: #{e}"
520
- end
521
- ```
522
-
523
- ### Parameters
524
-
525
- | Name | Type | Description | Notes |
526
- | ---- | ---- | ----------- | ----- |
527
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
528
- | **server_id** | **String** | The unique ID of the Server | |
529
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
530
- | **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] |
531
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
532
-
533
- ### Return type
534
-
535
- [**Server**](Server.md)
536
-
537
- ### Authorization
538
-
539
- Basic Authentication, Token Authentication
540
-
541
- ### HTTP request headers
542
-
543
- - **Content-Type**: Not defined
544
- - **Accept**: application/json
545
-
546
-
547
- ## datacenters_servers_get
548
-
549
- > <Servers> datacenters_servers_get(datacenter_id, opts)
550
-
551
- List Servers
552
-
553
- You can retrieve a list of servers within a datacenter
554
-
555
- ### Examples
556
-
557
- ```ruby
558
- require 'time'
559
- require 'ionoscloud'
560
- # setup authorization
561
- Ionoscloud.configure do |config|
562
- # Configure HTTP basic authorization: Basic Authentication
563
- config.username = 'YOUR USERNAME'
564
- config.password = 'YOUR PASSWORD'
565
-
566
- # Configure API key authorization: Token Authentication
567
- config.api_key['Authorization'] = 'YOUR API KEY'
568
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
569
- # config.api_key_prefix['Authorization'] = 'Bearer'
570
- end
571
-
572
- api_instance = Ionoscloud::ServerApi.new
573
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
574
- opts = {
575
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
576
- 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
577
- upgrade_needed: true, # Boolean | It can be used to filter which servers can be upgraded which can not be upgraded.
578
- x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
579
- offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
580
- limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
581
- }
582
-
583
- begin
584
- # List Servers
585
- result = api_instance.datacenters_servers_get(datacenter_id, opts)
586
- p result
587
- rescue Ionoscloud::ApiError => e
588
- puts "Error when calling ServerApi->datacenters_servers_get: #{e}"
589
- end
590
- ```
591
-
592
- #### Using the datacenters_servers_get_with_http_info variant
593
-
594
- This returns an Array which contains the response data, status code and headers.
595
-
596
- > <Array(<Servers>, Integer, Hash)> datacenters_servers_get_with_http_info(datacenter_id, opts)
597
-
598
- ```ruby
599
- begin
600
- # List Servers
601
- data, status_code, headers = api_instance.datacenters_servers_get_with_http_info(datacenter_id, opts)
602
- p status_code # => 2xx
603
- p headers # => { ... }
604
- p data # => <Servers>
605
- rescue Ionoscloud::ApiError => e
606
- puts "Error when calling ServerApi->datacenters_servers_get_with_http_info: #{e}"
607
- end
608
- ```
609
-
610
- ### Parameters
611
-
612
- | Name | Type | Description | Notes |
613
- | ---- | ---- | ----------- | ----- |
614
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
615
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
616
- | **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] |
617
- | **upgrade_needed** | **Boolean** | It can be used to filter which servers can be upgraded which can not be upgraded. | [optional] |
618
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
619
- | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) | [optional][default to 0] |
620
- | **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 1000] |
621
-
622
- ### Return type
623
-
624
- [**Servers**](Servers.md)
625
-
626
- ### Authorization
627
-
628
- Basic Authentication, Token Authentication
629
-
630
- ### HTTP request headers
631
-
632
- - **Content-Type**: Not defined
633
- - **Accept**: application/json
634
-
635
-
636
- ## datacenters_servers_patch
637
-
638
- > <Server> datacenters_servers_patch(datacenter_id, server_id, server, opts)
639
-
640
- Partially modify a Server
641
-
642
- You can use update attributes of a server
643
-
644
- ### Examples
645
-
646
- ```ruby
647
- require 'time'
648
- require 'ionoscloud'
649
- # setup authorization
650
- Ionoscloud.configure do |config|
651
- # Configure HTTP basic authorization: Basic Authentication
652
- config.username = 'YOUR USERNAME'
653
- config.password = 'YOUR PASSWORD'
654
-
655
- # Configure API key authorization: Token Authentication
656
- config.api_key['Authorization'] = 'YOUR API KEY'
657
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
658
- # config.api_key_prefix['Authorization'] = 'Bearer'
659
- end
660
-
661
- api_instance = Ionoscloud::ServerApi.new
662
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
663
- server_id = 'server_id_example' # String | The unique ID of the server
664
- server = Ionoscloud::ServerProperties.new({cores: 4, ram: 4096}) # ServerProperties | Modified properties of Server
665
- opts = {
666
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
667
- 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
668
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
669
- }
670
-
671
- begin
672
- # Partially modify a Server
673
- result = api_instance.datacenters_servers_patch(datacenter_id, server_id, server, opts)
674
- p result
675
- rescue Ionoscloud::ApiError => e
676
- puts "Error when calling ServerApi->datacenters_servers_patch: #{e}"
677
- end
678
- ```
679
-
680
- #### Using the datacenters_servers_patch_with_http_info variant
681
-
682
- This returns an Array which contains the response data, status code and headers.
683
-
684
- > <Array(<Server>, Integer, Hash)> datacenters_servers_patch_with_http_info(datacenter_id, server_id, server, opts)
685
-
686
- ```ruby
687
- begin
688
- # Partially modify a Server
689
- data, status_code, headers = api_instance.datacenters_servers_patch_with_http_info(datacenter_id, server_id, server, opts)
690
- p status_code # => 2xx
691
- p headers # => { ... }
692
- p data # => <Server>
693
- rescue Ionoscloud::ApiError => e
694
- puts "Error when calling ServerApi->datacenters_servers_patch_with_http_info: #{e}"
695
- end
696
- ```
697
-
698
- ### Parameters
699
-
700
- | Name | Type | Description | Notes |
701
- | ---- | ---- | ----------- | ----- |
702
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
703
- | **server_id** | **String** | The unique ID of the server | |
704
- | **server** | [**ServerProperties**](ServerProperties.md) | Modified properties of Server | |
705
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
706
- | **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] |
707
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
708
-
709
- ### Return type
710
-
711
- [**Server**](Server.md)
712
-
713
- ### Authorization
714
-
715
- Basic Authentication, Token Authentication
716
-
717
- ### HTTP request headers
718
-
719
- - **Content-Type**: application/json
720
- - **Accept**: application/json
721
-
722
-
723
- ## datacenters_servers_post
724
-
725
- > <Server> datacenters_servers_post(datacenter_id, server, opts)
726
-
727
- Create a Server
728
-
729
- Creates a server within an existing datacenter. You can configure the boot volume and connect the server to an existing LAN.
730
-
731
- ### Examples
732
-
733
- ```ruby
734
- require 'time'
735
- require 'ionoscloud'
736
- # setup authorization
737
- Ionoscloud.configure do |config|
738
- # Configure HTTP basic authorization: Basic Authentication
739
- config.username = 'YOUR USERNAME'
740
- config.password = 'YOUR PASSWORD'
741
-
742
- # Configure API key authorization: Token Authentication
743
- config.api_key['Authorization'] = 'YOUR API KEY'
744
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
745
- # config.api_key_prefix['Authorization'] = 'Bearer'
746
- end
747
-
748
- api_instance = Ionoscloud::ServerApi.new
749
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
750
- server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | Server to be created
751
- opts = {
752
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
753
- 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
754
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
755
- }
756
-
757
- begin
758
- # Create a Server
759
- result = api_instance.datacenters_servers_post(datacenter_id, server, opts)
760
- p result
761
- rescue Ionoscloud::ApiError => e
762
- puts "Error when calling ServerApi->datacenters_servers_post: #{e}"
763
- end
764
- ```
765
-
766
- #### Using the datacenters_servers_post_with_http_info variant
767
-
768
- This returns an Array which contains the response data, status code and headers.
769
-
770
- > <Array(<Server>, Integer, Hash)> datacenters_servers_post_with_http_info(datacenter_id, server, opts)
771
-
772
- ```ruby
773
- begin
774
- # Create a Server
775
- data, status_code, headers = api_instance.datacenters_servers_post_with_http_info(datacenter_id, server, opts)
776
- p status_code # => 2xx
777
- p headers # => { ... }
778
- p data # => <Server>
779
- rescue Ionoscloud::ApiError => e
780
- puts "Error when calling ServerApi->datacenters_servers_post_with_http_info: #{e}"
781
- end
782
- ```
783
-
784
- ### Parameters
785
-
786
- | Name | Type | Description | Notes |
787
- | ---- | ---- | ----------- | ----- |
788
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
789
- | **server** | [**Server**](Server.md) | Server to be created | |
790
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
791
- | **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] |
792
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
793
-
794
- ### Return type
795
-
796
- [**Server**](Server.md)
797
-
798
- ### Authorization
799
-
800
- Basic Authentication, Token Authentication
801
-
802
- ### HTTP request headers
803
-
804
- - **Content-Type**: application/json
805
- - **Accept**: application/json
806
-
807
-
808
- ## datacenters_servers_put
809
-
810
- > <Server> datacenters_servers_put(datacenter_id, server_id, server, opts)
811
-
812
- Modify a Server
813
-
814
- Allows to modify the attributes of a Server. From v5 onwards 'allowReboot' attribute will no longer be available. For certain server property change it was earlier forced to be provided. Now this behaviour is implicit and backend will do this automatically e.g. in earlier versions, when CPU family changes, the 'allowReboot' property was required to be set to true which will no longer be the case and the server will be rebooted automatically
815
-
816
- ### Examples
817
-
818
- ```ruby
819
- require 'time'
820
- require 'ionoscloud'
821
- # setup authorization
822
- Ionoscloud.configure do |config|
823
- # Configure HTTP basic authorization: Basic Authentication
824
- config.username = 'YOUR USERNAME'
825
- config.password = 'YOUR PASSWORD'
826
-
827
- # Configure API key authorization: Token Authentication
828
- config.api_key['Authorization'] = 'YOUR API KEY'
829
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
830
- # config.api_key_prefix['Authorization'] = 'Bearer'
831
- end
832
-
833
- api_instance = Ionoscloud::ServerApi.new
834
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
835
- server_id = 'server_id_example' # String | The unique ID of the server
836
- server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | Modified Server
837
- opts = {
838
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
839
- 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
840
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
841
- }
842
-
843
- begin
844
- # Modify a Server
845
- result = api_instance.datacenters_servers_put(datacenter_id, server_id, server, opts)
846
- p result
847
- rescue Ionoscloud::ApiError => e
848
- puts "Error when calling ServerApi->datacenters_servers_put: #{e}"
849
- end
850
- ```
851
-
852
- #### Using the datacenters_servers_put_with_http_info variant
853
-
854
- This returns an Array which contains the response data, status code and headers.
855
-
856
- > <Array(<Server>, Integer, Hash)> datacenters_servers_put_with_http_info(datacenter_id, server_id, server, opts)
857
-
858
- ```ruby
859
- begin
860
- # Modify a Server
861
- data, status_code, headers = api_instance.datacenters_servers_put_with_http_info(datacenter_id, server_id, server, opts)
862
- p status_code # => 2xx
863
- p headers # => { ... }
864
- p data # => <Server>
865
- rescue Ionoscloud::ApiError => e
866
- puts "Error when calling ServerApi->datacenters_servers_put_with_http_info: #{e}"
867
- end
868
- ```
869
-
870
- ### Parameters
871
-
872
- | Name | Type | Description | Notes |
873
- | ---- | ---- | ----------- | ----- |
874
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
875
- | **server_id** | **String** | The unique ID of the server | |
876
- | **server** | [**Server**](Server.md) | Modified Server | |
877
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
878
- | **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] |
879
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
880
-
881
- ### Return type
882
-
883
- [**Server**](Server.md)
884
-
885
- ### Authorization
886
-
887
- Basic Authentication, Token Authentication
888
-
889
- ### HTTP request headers
890
-
891
- - **Content-Type**: application/json
892
- - **Accept**: application/json
893
-
894
-
895
- ## datacenters_servers_reboot_post
896
-
897
- > Object datacenters_servers_reboot_post(datacenter_id, server_id, opts)
898
-
899
- Reboot a Server
900
-
901
- This will force a hard reboot of the server. Do not use this method if you want to gracefully reboot the machine. This is the equivalent of powering off the machine and turning it back on.
902
-
903
- ### Examples
904
-
905
- ```ruby
906
- require 'time'
907
- require 'ionoscloud'
908
- # setup authorization
909
- Ionoscloud.configure do |config|
910
- # Configure HTTP basic authorization: Basic Authentication
911
- config.username = 'YOUR USERNAME'
912
- config.password = 'YOUR PASSWORD'
913
-
914
- # Configure API key authorization: Token Authentication
915
- config.api_key['Authorization'] = 'YOUR API KEY'
916
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
917
- # config.api_key_prefix['Authorization'] = 'Bearer'
918
- end
919
-
920
- api_instance = Ionoscloud::ServerApi.new
921
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
922
- server_id = 'server_id_example' # String | The unique ID of the Server
923
- opts = {
924
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
925
- 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
926
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
927
- }
928
-
929
- begin
930
- # Reboot a Server
931
- result = api_instance.datacenters_servers_reboot_post(datacenter_id, server_id, opts)
932
- p result
933
- rescue Ionoscloud::ApiError => e
934
- puts "Error when calling ServerApi->datacenters_servers_reboot_post: #{e}"
935
- end
936
- ```
937
-
938
- #### Using the datacenters_servers_reboot_post_with_http_info variant
939
-
940
- This returns an Array which contains the response data, status code and headers.
941
-
942
- > <Array(Object, Integer, Hash)> datacenters_servers_reboot_post_with_http_info(datacenter_id, server_id, opts)
943
-
944
- ```ruby
945
- begin
946
- # Reboot a Server
947
- data, status_code, headers = api_instance.datacenters_servers_reboot_post_with_http_info(datacenter_id, server_id, opts)
948
- p status_code # => 2xx
949
- p headers # => { ... }
950
- p data # => Object
951
- rescue Ionoscloud::ApiError => e
952
- puts "Error when calling ServerApi->datacenters_servers_reboot_post_with_http_info: #{e}"
953
- end
954
- ```
955
-
956
- ### Parameters
957
-
958
- | Name | Type | Description | Notes |
959
- | ---- | ---- | ----------- | ----- |
960
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
961
- | **server_id** | **String** | The unique ID of the Server | |
962
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
963
- | **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] |
964
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
965
-
966
- ### Return type
967
-
968
- **Object**
969
-
970
- ### Authorization
971
-
972
- Basic Authentication, Token Authentication
973
-
974
- ### HTTP request headers
975
-
976
- - **Content-Type**: Not defined
977
- - **Accept**: application/json
978
-
979
-
980
- ## datacenters_servers_start_post
981
-
982
- > Object datacenters_servers_start_post(datacenter_id, server_id, opts)
983
-
984
- Start a Server
985
-
986
- This will start a server. If the server's public IP was deallocated then a new IP will be assigned
987
-
988
- ### Examples
989
-
990
- ```ruby
991
- require 'time'
992
- require 'ionoscloud'
993
- # setup authorization
994
- Ionoscloud.configure do |config|
995
- # Configure HTTP basic authorization: Basic Authentication
996
- config.username = 'YOUR USERNAME'
997
- config.password = 'YOUR PASSWORD'
998
-
999
- # Configure API key authorization: Token Authentication
1000
- config.api_key['Authorization'] = 'YOUR API KEY'
1001
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1002
- # config.api_key_prefix['Authorization'] = 'Bearer'
1003
- end
1004
-
1005
- api_instance = Ionoscloud::ServerApi.new
1006
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1007
- server_id = 'server_id_example' # String | The unique ID of the Server
1008
- opts = {
1009
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1010
- 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
1011
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1012
- }
1013
-
1014
- begin
1015
- # Start a Server
1016
- result = api_instance.datacenters_servers_start_post(datacenter_id, server_id, opts)
1017
- p result
1018
- rescue Ionoscloud::ApiError => e
1019
- puts "Error when calling ServerApi->datacenters_servers_start_post: #{e}"
1020
- end
1021
- ```
1022
-
1023
- #### Using the datacenters_servers_start_post_with_http_info variant
1024
-
1025
- This returns an Array which contains the response data, status code and headers.
1026
-
1027
- > <Array(Object, Integer, Hash)> datacenters_servers_start_post_with_http_info(datacenter_id, server_id, opts)
1028
-
1029
- ```ruby
1030
- begin
1031
- # Start a Server
1032
- data, status_code, headers = api_instance.datacenters_servers_start_post_with_http_info(datacenter_id, server_id, opts)
1033
- p status_code # => 2xx
1034
- p headers # => { ... }
1035
- p data # => Object
1036
- rescue Ionoscloud::ApiError => e
1037
- puts "Error when calling ServerApi->datacenters_servers_start_post_with_http_info: #{e}"
1038
- end
1039
- ```
1040
-
1041
- ### Parameters
1042
-
1043
- | Name | Type | Description | Notes |
1044
- | ---- | ---- | ----------- | ----- |
1045
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1046
- | **server_id** | **String** | The unique ID of the Server | |
1047
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1048
- | **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] |
1049
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1050
-
1051
- ### Return type
1052
-
1053
- **Object**
1054
-
1055
- ### Authorization
1056
-
1057
- Basic Authentication, Token Authentication
1058
-
1059
- ### HTTP request headers
1060
-
1061
- - **Content-Type**: Not defined
1062
- - **Accept**: application/json
1063
-
1064
-
1065
- ## datacenters_servers_stop_post
1066
-
1067
- > Object datacenters_servers_stop_post(datacenter_id, server_id, opts)
1068
-
1069
- Stop a Server
1070
-
1071
- This will stop a server. The machine will be forcefully powered off, billing will cease, and the public IP, if one is allocated, will be deallocated. The operation is not supported for Cube servers.
1072
-
1073
- ### Examples
1074
-
1075
- ```ruby
1076
- require 'time'
1077
- require 'ionoscloud'
1078
- # setup authorization
1079
- Ionoscloud.configure do |config|
1080
- # Configure HTTP basic authorization: Basic Authentication
1081
- config.username = 'YOUR USERNAME'
1082
- config.password = 'YOUR PASSWORD'
1083
-
1084
- # Configure API key authorization: Token Authentication
1085
- config.api_key['Authorization'] = 'YOUR API KEY'
1086
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1087
- # config.api_key_prefix['Authorization'] = 'Bearer'
1088
- end
1089
-
1090
- api_instance = Ionoscloud::ServerApi.new
1091
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1092
- server_id = 'server_id_example' # String | The unique ID of the Server
1093
- opts = {
1094
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1095
- 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
1096
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1097
- }
1098
-
1099
- begin
1100
- # Stop a Server
1101
- result = api_instance.datacenters_servers_stop_post(datacenter_id, server_id, opts)
1102
- p result
1103
- rescue Ionoscloud::ApiError => e
1104
- puts "Error when calling ServerApi->datacenters_servers_stop_post: #{e}"
1105
- end
1106
- ```
1107
-
1108
- #### Using the datacenters_servers_stop_post_with_http_info variant
1109
-
1110
- This returns an Array which contains the response data, status code and headers.
1111
-
1112
- > <Array(Object, Integer, Hash)> datacenters_servers_stop_post_with_http_info(datacenter_id, server_id, opts)
1113
-
1114
- ```ruby
1115
- begin
1116
- # Stop a Server
1117
- data, status_code, headers = api_instance.datacenters_servers_stop_post_with_http_info(datacenter_id, server_id, opts)
1118
- p status_code # => 2xx
1119
- p headers # => { ... }
1120
- p data # => Object
1121
- rescue Ionoscloud::ApiError => e
1122
- puts "Error when calling ServerApi->datacenters_servers_stop_post_with_http_info: #{e}"
1123
- end
1124
- ```
1125
-
1126
- ### Parameters
1127
-
1128
- | Name | Type | Description | Notes |
1129
- | ---- | ---- | ----------- | ----- |
1130
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1131
- | **server_id** | **String** | The unique ID of the Server | |
1132
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1133
- | **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] |
1134
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1135
-
1136
- ### Return type
1137
-
1138
- **Object**
1139
-
1140
- ### Authorization
1141
-
1142
- Basic Authentication, Token Authentication
1143
-
1144
- ### HTTP request headers
1145
-
1146
- - **Content-Type**: Not defined
1147
- - **Accept**: application/json
1148
-
1149
-
1150
- ## datacenters_servers_upgrade_post
1151
-
1152
- > Object datacenters_servers_upgrade_post(datacenter_id, server_id, opts)
1153
-
1154
- Upgrade a Server
1155
-
1156
- This will upgrade the version of the server, if needed. To verify if there is an upgrade available for a server, call '/datacenters/{datacenterId}/servers?upgradeNeeded=true'
1157
-
1158
- ### Examples
1159
-
1160
- ```ruby
1161
- require 'time'
1162
- require 'ionoscloud'
1163
- # setup authorization
1164
- Ionoscloud.configure do |config|
1165
- # Configure HTTP basic authorization: Basic Authentication
1166
- config.username = 'YOUR USERNAME'
1167
- config.password = 'YOUR PASSWORD'
1168
-
1169
- # Configure API key authorization: Token Authentication
1170
- config.api_key['Authorization'] = 'YOUR API KEY'
1171
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1172
- # config.api_key_prefix['Authorization'] = 'Bearer'
1173
- end
1174
-
1175
- api_instance = Ionoscloud::ServerApi.new
1176
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1177
- server_id = 'server_id_example' # String | The unique ID of the Server
1178
- opts = {
1179
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1180
- 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
1181
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1182
- }
1183
-
1184
- begin
1185
- # Upgrade a Server
1186
- result = api_instance.datacenters_servers_upgrade_post(datacenter_id, server_id, opts)
1187
- p result
1188
- rescue Ionoscloud::ApiError => e
1189
- puts "Error when calling ServerApi->datacenters_servers_upgrade_post: #{e}"
1190
- end
1191
- ```
1192
-
1193
- #### Using the datacenters_servers_upgrade_post_with_http_info variant
1194
-
1195
- This returns an Array which contains the response data, status code and headers.
1196
-
1197
- > <Array(Object, Integer, Hash)> datacenters_servers_upgrade_post_with_http_info(datacenter_id, server_id, opts)
1198
-
1199
- ```ruby
1200
- begin
1201
- # Upgrade a Server
1202
- data, status_code, headers = api_instance.datacenters_servers_upgrade_post_with_http_info(datacenter_id, server_id, opts)
1203
- p status_code # => 2xx
1204
- p headers # => { ... }
1205
- p data # => Object
1206
- rescue Ionoscloud::ApiError => e
1207
- puts "Error when calling ServerApi->datacenters_servers_upgrade_post_with_http_info: #{e}"
1208
- end
1209
- ```
1210
-
1211
- ### Parameters
1212
-
1213
- | Name | Type | Description | Notes |
1214
- | ---- | ---- | ----------- | ----- |
1215
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1216
- | **server_id** | **String** | The unique ID of the Server | |
1217
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1218
- | **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] |
1219
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1220
-
1221
- ### Return type
1222
-
1223
- **Object**
1224
-
1225
- ### Authorization
1226
-
1227
- Basic Authentication, Token Authentication
1228
-
1229
- ### HTTP request headers
1230
-
1231
- - **Content-Type**: Not defined
1232
- - **Accept**: application/json
1233
-
1234
-
1235
- ## datacenters_servers_volumes_delete
1236
-
1237
- > Object datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, opts)
1238
-
1239
- Detach a volume
1240
-
1241
- This will detach the volume from the server. This will not delete the volume from your datacenter. You will need to make a separate request to perform a deletion
1242
-
1243
- ### Examples
1244
-
1245
- ```ruby
1246
- require 'time'
1247
- require 'ionoscloud'
1248
- # setup authorization
1249
- Ionoscloud.configure do |config|
1250
- # Configure HTTP basic authorization: Basic Authentication
1251
- config.username = 'YOUR USERNAME'
1252
- config.password = 'YOUR PASSWORD'
1253
-
1254
- # Configure API key authorization: Token Authentication
1255
- config.api_key['Authorization'] = 'YOUR API KEY'
1256
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1257
- # config.api_key_prefix['Authorization'] = 'Bearer'
1258
- end
1259
-
1260
- api_instance = Ionoscloud::ServerApi.new
1261
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1262
- server_id = 'server_id_example' # String | The unique ID of the Server
1263
- volume_id = 'volume_id_example' # String | The unique ID of the Volume
1264
- opts = {
1265
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1266
- 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
1267
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1268
- }
1269
-
1270
- begin
1271
- # Detach a volume
1272
- result = api_instance.datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, opts)
1273
- p result
1274
- rescue Ionoscloud::ApiError => e
1275
- puts "Error when calling ServerApi->datacenters_servers_volumes_delete: #{e}"
1276
- end
1277
- ```
1278
-
1279
- #### Using the datacenters_servers_volumes_delete_with_http_info variant
1280
-
1281
- This returns an Array which contains the response data, status code and headers.
1282
-
1283
- > <Array(Object, Integer, Hash)> datacenters_servers_volumes_delete_with_http_info(datacenter_id, server_id, volume_id, opts)
1284
-
1285
- ```ruby
1286
- begin
1287
- # Detach a volume
1288
- data, status_code, headers = api_instance.datacenters_servers_volumes_delete_with_http_info(datacenter_id, server_id, volume_id, opts)
1289
- p status_code # => 2xx
1290
- p headers # => { ... }
1291
- p data # => Object
1292
- rescue Ionoscloud::ApiError => e
1293
- puts "Error when calling ServerApi->datacenters_servers_volumes_delete_with_http_info: #{e}"
1294
- end
1295
- ```
1296
-
1297
- ### Parameters
1298
-
1299
- | Name | Type | Description | Notes |
1300
- | ---- | ---- | ----------- | ----- |
1301
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1302
- | **server_id** | **String** | The unique ID of the Server | |
1303
- | **volume_id** | **String** | The unique ID of the Volume | |
1304
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1305
- | **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] |
1306
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1307
-
1308
- ### Return type
1309
-
1310
- **Object**
1311
-
1312
- ### Authorization
1313
-
1314
- Basic Authentication, Token Authentication
1315
-
1316
- ### HTTP request headers
1317
-
1318
- - **Content-Type**: Not defined
1319
- - **Accept**: application/json
1320
-
1321
-
1322
- ## datacenters_servers_volumes_find_by_id
1323
-
1324
- > <Volume> datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, opts)
1325
-
1326
- Retrieve an attached volume
1327
-
1328
- This will retrieve the properties of an attached volume.
1329
-
1330
- ### Examples
1331
-
1332
- ```ruby
1333
- require 'time'
1334
- require 'ionoscloud'
1335
- # setup authorization
1336
- Ionoscloud.configure do |config|
1337
- # Configure HTTP basic authorization: Basic Authentication
1338
- config.username = 'YOUR USERNAME'
1339
- config.password = 'YOUR PASSWORD'
1340
-
1341
- # Configure API key authorization: Token Authentication
1342
- config.api_key['Authorization'] = 'YOUR API KEY'
1343
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1344
- # config.api_key_prefix['Authorization'] = 'Bearer'
1345
- end
1346
-
1347
- api_instance = Ionoscloud::ServerApi.new
1348
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1349
- server_id = 'server_id_example' # String | The unique ID of the Server
1350
- volume_id = 'volume_id_example' # String | The unique ID of the Volume
1351
- opts = {
1352
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1353
- 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
1354
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1355
- }
1356
-
1357
- begin
1358
- # Retrieve an attached volume
1359
- result = api_instance.datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, opts)
1360
- p result
1361
- rescue Ionoscloud::ApiError => e
1362
- puts "Error when calling ServerApi->datacenters_servers_volumes_find_by_id: #{e}"
1363
- end
1364
- ```
1365
-
1366
- #### Using the datacenters_servers_volumes_find_by_id_with_http_info variant
1367
-
1368
- This returns an Array which contains the response data, status code and headers.
1369
-
1370
- > <Array(<Volume>, Integer, Hash)> datacenters_servers_volumes_find_by_id_with_http_info(datacenter_id, server_id, volume_id, opts)
1371
-
1372
- ```ruby
1373
- begin
1374
- # Retrieve an attached volume
1375
- data, status_code, headers = api_instance.datacenters_servers_volumes_find_by_id_with_http_info(datacenter_id, server_id, volume_id, opts)
1376
- p status_code # => 2xx
1377
- p headers # => { ... }
1378
- p data # => <Volume>
1379
- rescue Ionoscloud::ApiError => e
1380
- puts "Error when calling ServerApi->datacenters_servers_volumes_find_by_id_with_http_info: #{e}"
1381
- end
1382
- ```
1383
-
1384
- ### Parameters
1385
-
1386
- | Name | Type | Description | Notes |
1387
- | ---- | ---- | ----------- | ----- |
1388
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1389
- | **server_id** | **String** | The unique ID of the Server | |
1390
- | **volume_id** | **String** | The unique ID of the Volume | |
1391
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1392
- | **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] |
1393
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1394
-
1395
- ### Return type
1396
-
1397
- [**Volume**](Volume.md)
1398
-
1399
- ### Authorization
1400
-
1401
- Basic Authentication, Token Authentication
1402
-
1403
- ### HTTP request headers
1404
-
1405
- - **Content-Type**: Not defined
1406
- - **Accept**: application/json
1407
-
1408
-
1409
- ## datacenters_servers_volumes_get
1410
-
1411
- > <AttachedVolumes> datacenters_servers_volumes_get(datacenter_id, server_id, opts)
1412
-
1413
- List Attached Volumes
1414
-
1415
- You can retrieve a list of volumes attached to the server
1416
-
1417
- ### Examples
1418
-
1419
- ```ruby
1420
- require 'time'
1421
- require 'ionoscloud'
1422
- # setup authorization
1423
- Ionoscloud.configure do |config|
1424
- # Configure HTTP basic authorization: Basic Authentication
1425
- config.username = 'YOUR USERNAME'
1426
- config.password = 'YOUR PASSWORD'
1427
- end
1428
-
1429
- api_instance = Ionoscloud::ServerApi.new
1430
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1431
- server_id = 'server_id_example' # String | The unique ID of the Server
1432
- opts = {
1433
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1434
- 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
1435
- x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1436
- offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
1437
- limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
1438
- }
1439
-
1440
- begin
1441
- # List Attached Volumes
1442
- result = api_instance.datacenters_servers_volumes_get(datacenter_id, server_id, opts)
1443
- p result
1444
- rescue Ionoscloud::ApiError => e
1445
- puts "Error when calling ServerApi->datacenters_servers_volumes_get: #{e}"
1446
- end
1447
- ```
1448
-
1449
- #### Using the datacenters_servers_volumes_get_with_http_info variant
1450
-
1451
- This returns an Array which contains the response data, status code and headers.
1452
-
1453
- > <Array(<AttachedVolumes>, Integer, Hash)> datacenters_servers_volumes_get_with_http_info(datacenter_id, server_id, opts)
1454
-
1455
- ```ruby
1456
- begin
1457
- # List Attached Volumes
1458
- data, status_code, headers = api_instance.datacenters_servers_volumes_get_with_http_info(datacenter_id, server_id, opts)
1459
- p status_code # => 2xx
1460
- p headers # => { ... }
1461
- p data # => <AttachedVolumes>
1462
- rescue Ionoscloud::ApiError => e
1463
- puts "Error when calling ServerApi->datacenters_servers_volumes_get_with_http_info: #{e}"
1464
- end
1465
- ```
1466
-
1467
- ### Parameters
1468
-
1469
- | Name | Type | Description | Notes |
1470
- | ---- | ---- | ----------- | ----- |
1471
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1472
- | **server_id** | **String** | The unique ID of the Server | |
1473
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1474
- | **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] |
1475
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1476
- | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) | [optional][default to 0] |
1477
- | **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 1000] |
1478
-
1479
- ### Return type
1480
-
1481
- [**AttachedVolumes**](AttachedVolumes.md)
1482
-
1483
- ### Authorization
1484
-
1485
- Basic Authentication
1486
-
1487
- ### HTTP request headers
1488
-
1489
- - **Content-Type**: Not defined
1490
- - **Accept**: application/json
1491
-
1492
-
1493
- ## datacenters_servers_volumes_post
1494
-
1495
- > <Volume> datacenters_servers_volumes_post(datacenter_id, server_id, volume, opts)
1496
-
1497
- Attach a volume
1498
-
1499
- This will attach a pre-existing storage volume to the server. It is also possible to create and attach a volume in one step just by providing a new volume description as payload. Combine count of Nics and volumes attached to the server should not exceed size 24.
1500
-
1501
- ### Examples
1502
-
1503
- ```ruby
1504
- require 'time'
1505
- require 'ionoscloud'
1506
- # setup authorization
1507
- Ionoscloud.configure do |config|
1508
- # Configure HTTP basic authorization: Basic Authentication
1509
- config.username = 'YOUR USERNAME'
1510
- config.password = 'YOUR PASSWORD'
1511
- end
1512
-
1513
- api_instance = Ionoscloud::ServerApi.new
1514
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1515
- server_id = 'server_id_example' # String | The unique ID of the Server
1516
- volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | Volume to be attached (created and attached)
1517
- opts = {
1518
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1519
- 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
1520
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1521
- }
1522
-
1523
- begin
1524
- # Attach a volume
1525
- result = api_instance.datacenters_servers_volumes_post(datacenter_id, server_id, volume, opts)
1526
- p result
1527
- rescue Ionoscloud::ApiError => e
1528
- puts "Error when calling ServerApi->datacenters_servers_volumes_post: #{e}"
1529
- end
1530
- ```
1531
-
1532
- #### Using the datacenters_servers_volumes_post_with_http_info variant
1533
-
1534
- This returns an Array which contains the response data, status code and headers.
1535
-
1536
- > <Array(<Volume>, Integer, Hash)> datacenters_servers_volumes_post_with_http_info(datacenter_id, server_id, volume, opts)
1537
-
1538
- ```ruby
1539
- begin
1540
- # Attach a volume
1541
- data, status_code, headers = api_instance.datacenters_servers_volumes_post_with_http_info(datacenter_id, server_id, volume, opts)
1542
- p status_code # => 2xx
1543
- p headers # => { ... }
1544
- p data # => <Volume>
1545
- rescue Ionoscloud::ApiError => e
1546
- puts "Error when calling ServerApi->datacenters_servers_volumes_post_with_http_info: #{e}"
1547
- end
1548
- ```
1549
-
1550
- ### Parameters
1551
-
1552
- | Name | Type | Description | Notes |
1553
- | ---- | ---- | ----------- | ----- |
1554
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1555
- | **server_id** | **String** | The unique ID of the Server | |
1556
- | **volume** | [**Volume**](Volume.md) | Volume to be attached (created and attached) | |
1557
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1558
- | **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] |
1559
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1560
-
1561
- ### Return type
1562
-
1563
- [**Volume**](Volume.md)
1564
-
1565
- ### Authorization
1566
-
1567
- Basic Authentication
1568
-
1569
- ### HTTP request headers
1570
-
1571
- - **Content-Type**: application/json
1572
- - **Accept**: application/json
1573
-