ionoscloud 6.0.0.beta.1 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (624) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +190 -0
  3. data/README.md +57 -0
  4. data/docs/README.md +64 -0
  5. data/docs/api/BackupUnitsApi.md +594 -0
  6. data/docs/{ContractResourcesApi.md → api/ContractResourcesApi.md} +12 -12
  7. data/docs/api/DataCentersApi.md +516 -0
  8. data/docs/api/DefaultApi.md +78 -0
  9. data/docs/{FirewallRulesApi.md → api/FirewallRulesApi.md} +131 -132
  10. data/docs/{FlowLogsApi.md → api/FlowLogsApi.md} +115 -116
  11. data/docs/api/IPBlocksApi.md +516 -0
  12. data/docs/api/ImagesApi.md +428 -0
  13. data/docs/{KubernetesApi.md → api/KubernetesApi.md} +266 -270
  14. data/docs/api/LANsApi.md +794 -0
  15. data/docs/api/LabelsApi.md +2338 -0
  16. data/docs/{LoadBalancersApi.md → api/LoadBalancersApi.md} +178 -188
  17. data/docs/api/LocationsApi.md +259 -0
  18. data/docs/{NATGatewaysApi.md → api/NATGatewaysApi.md} +317 -324
  19. data/docs/api/NetworkInterfacesApi.md +540 -0
  20. data/docs/{NetworkLoadBalancersApi.md → api/NetworkLoadBalancersApi.md} +333 -340
  21. data/docs/api/PrivateCrossConnectsApi.md +426 -0
  22. data/docs/api/RequestsApi.md +283 -0
  23. data/docs/api/ServersApi.md +1908 -0
  24. data/docs/api/SnapshotsApi.md +428 -0
  25. data/docs/{TemplatesApi.md → api/TemplatesApi.md} +18 -18
  26. data/docs/api/UserManagementApi.md +2039 -0
  27. data/docs/api/UserS3KeysApi.md +516 -0
  28. data/docs/api/VolumesApi.md +709 -0
  29. data/docs/{AttachedVolumes.md → models/AttachedVolumes.md} +6 -6
  30. data/docs/{BackupUnit.md → models/BackupUnit.md} +3 -3
  31. data/docs/{BackupUnitProperties.md → models/BackupUnitProperties.md} +2 -2
  32. data/docs/{BackupUnitSSO.md → models/BackupUnitSSO.md} +0 -0
  33. data/docs/{BackupUnits.md → models/BackupUnits.md} +4 -4
  34. data/docs/{BalancedNics.md → models/BalancedNics.md} +6 -6
  35. data/docs/{Cdroms.md → models/Cdroms.md} +6 -6
  36. data/docs/{ConnectableDatacenter.md → models/ConnectableDatacenter.md} +0 -0
  37. data/docs/{Contract.md → models/Contract.md} +1 -1
  38. data/docs/{ContractProperties.md → models/ContractProperties.md} +4 -4
  39. data/docs/{Contracts.md → models/Contracts.md} +3 -3
  40. data/docs/{CpuArchitectureProperties.md → models/CpuArchitectureProperties.md} +1 -1
  41. data/docs/{DataCenterEntities.md → models/DataCenterEntities.md} +0 -0
  42. data/docs/{Datacenter.md → models/Datacenter.md} +3 -3
  43. data/docs/{DatacenterElementMetadata.md → models/DatacenterElementMetadata.md} +6 -6
  44. data/docs/{DatacenterProperties.md → models/DatacenterProperties.md} +6 -6
  45. data/docs/{Datacenters.md → models/Datacenters.md} +6 -6
  46. data/docs/{Error.md → models/Error.md} +1 -1
  47. data/docs/{ErrorMessage.md → models/ErrorMessage.md} +3 -3
  48. data/docs/{FirewallRule.md → models/FirewallRule.md} +3 -3
  49. data/docs/{FirewallRules.md → models/FirewallRules.md} +6 -6
  50. data/docs/{FirewallruleProperties.md → models/FirewallruleProperties.md} +10 -10
  51. data/docs/{FlowLog.md → models/FlowLog.md} +3 -3
  52. data/docs/{FlowLogProperties.md → models/FlowLogProperties.md} +1 -1
  53. data/docs/{FlowLogPut.md → models/FlowLogPut.md} +3 -3
  54. data/docs/{FlowLogs.md → models/FlowLogs.md} +6 -6
  55. data/docs/{Group.md → models/Group.md} +3 -3
  56. data/docs/{GroupEntities.md → models/GroupEntities.md} +0 -0
  57. data/docs/{GroupMembers.md → models/GroupMembers.md} +4 -4
  58. data/docs/models/GroupProperties.md +42 -0
  59. data/docs/{GroupShare.md → models/GroupShare.md} +2 -2
  60. data/docs/{GroupShareProperties.md → models/GroupShareProperties.md} +0 -0
  61. data/docs/{GroupShares.md → models/GroupShares.md} +3 -3
  62. data/docs/{GroupUsers.md → models/GroupUsers.md} +4 -4
  63. data/docs/{Groups.md → models/Groups.md} +4 -4
  64. data/docs/{IPFailover.md → models/IPFailover.md} +0 -0
  65. data/docs/{Image.md → models/Image.md} +3 -3
  66. data/docs/models/ImageProperties.md +54 -0
  67. data/docs/{Images.md → models/Images.md} +4 -4
  68. data/docs/{Info.md → models/Info.md} +0 -0
  69. data/docs/{IpBlock.md → models/IpBlock.md} +3 -3
  70. data/docs/models/IpBlockProperties.md +26 -0
  71. data/docs/models/IpBlocks.md +30 -0
  72. data/docs/{IpConsumer.md → models/IpConsumer.md} +5 -1
  73. data/docs/{KubernetesAutoScaling.md → models/KubernetesAutoScaling.md} +0 -0
  74. data/docs/{KubernetesCluster.md → models/KubernetesCluster.md} +2 -2
  75. data/docs/{KubernetesClusterEntities.md → models/KubernetesClusterEntities.md} +0 -0
  76. data/docs/{KubernetesClusterForPost.md → models/KubernetesClusterForPost.md} +2 -2
  77. data/docs/{KubernetesClusterForPut.md → models/KubernetesClusterForPut.md} +2 -2
  78. data/docs/models/KubernetesClusterProperties.md +30 -0
  79. data/docs/models/KubernetesClusterPropertiesForPost.md +26 -0
  80. data/docs/models/KubernetesClusterPropertiesForPut.md +26 -0
  81. data/docs/{KubernetesClusters.md → models/KubernetesClusters.md} +4 -4
  82. data/docs/{KubernetesMaintenanceWindow.md → models/KubernetesMaintenanceWindow.md} +0 -0
  83. data/docs/{KubernetesNode.md → models/KubernetesNode.md} +2 -2
  84. data/docs/{KubernetesNodeMetadata.md → models/KubernetesNodeMetadata.md} +4 -4
  85. data/docs/{KubernetesNodePool.md → models/KubernetesNodePool.md} +2 -2
  86. data/docs/{KubernetesNodePoolForPost.md → models/KubernetesNodePoolForPost.md} +2 -2
  87. data/docs/{KubernetesNodePoolForPut.md → models/KubernetesNodePoolForPut.md} +2 -2
  88. data/docs/{KubernetesNodePoolLan.md → models/KubernetesNodePoolLan.md} +2 -2
  89. data/docs/{KubernetesNodePoolLanRoutes.md → models/KubernetesNodePoolLanRoutes.md} +0 -0
  90. data/docs/{KubernetesNodePoolProperties.md → models/KubernetesNodePoolProperties.md} +13 -14
  91. data/docs/{KubernetesNodePoolPropertiesForPost.md → models/KubernetesNodePoolPropertiesForPost.md} +12 -13
  92. data/docs/{KubernetesNodePoolPropertiesForPut.md → models/KubernetesNodePoolPropertiesForPut.md} +5 -5
  93. data/docs/{KubernetesNodePools.md → models/KubernetesNodePools.md} +4 -4
  94. data/docs/{KubernetesNodeProperties.md → models/KubernetesNodeProperties.md} +2 -2
  95. data/docs/{KubernetesNodes.md → models/KubernetesNodes.md} +4 -4
  96. data/docs/{Label.md → models/Label.md} +2 -2
  97. data/docs/{LabelProperties.md → models/LabelProperties.md} +3 -3
  98. data/docs/{LabelResource.md → models/LabelResource.md} +2 -2
  99. data/docs/{LabelResourceProperties.md → models/LabelResourceProperties.md} +2 -2
  100. data/docs/{LabelResources.md → models/LabelResources.md} +6 -6
  101. data/docs/{Labels.md → models/Labels.md} +4 -4
  102. data/docs/{Lan.md → models/Lan.md} +3 -3
  103. data/docs/{LanEntities.md → models/LanEntities.md} +0 -0
  104. data/docs/{LanNics.md → models/LanNics.md} +6 -6
  105. data/docs/{LanPost.md → models/LanPost.md} +3 -3
  106. data/docs/{LanProperties.md → models/LanProperties.md} +3 -3
  107. data/docs/{LanPropertiesPost.md → models/LanPropertiesPost.md} +3 -3
  108. data/docs/{Lans.md → models/Lans.md} +6 -6
  109. data/docs/{Loadbalancer.md → models/Loadbalancer.md} +3 -3
  110. data/docs/{LoadbalancerEntities.md → models/LoadbalancerEntities.md} +0 -0
  111. data/docs/{LoadbalancerProperties.md → models/LoadbalancerProperties.md} +3 -3
  112. data/docs/{Loadbalancers.md → models/Loadbalancers.md} +6 -6
  113. data/docs/{Location.md → models/Location.md} +3 -3
  114. data/docs/{LocationProperties.md → models/LocationProperties.md} +1 -1
  115. data/docs/{Locations.md → models/Locations.md} +4 -4
  116. data/docs/{NatGateway.md → models/NatGateway.md} +3 -3
  117. data/docs/{NatGatewayEntities.md → models/NatGatewayEntities.md} +0 -0
  118. data/docs/{NatGatewayLanProperties.md → models/NatGatewayLanProperties.md} +2 -2
  119. data/docs/{NatGatewayProperties.md → models/NatGatewayProperties.md} +3 -3
  120. data/docs/{NatGatewayPut.md → models/NatGatewayPut.md} +3 -3
  121. data/docs/{NatGatewayRule.md → models/NatGatewayRule.md} +3 -3
  122. data/docs/{NatGatewayRuleProperties.md → models/NatGatewayRuleProperties.md} +7 -7
  123. data/docs/{NatGatewayRuleProtocol.md → models/NatGatewayRuleProtocol.md} +0 -0
  124. data/docs/{NatGatewayRulePut.md → models/NatGatewayRulePut.md} +3 -3
  125. data/docs/{NatGatewayRuleType.md → models/NatGatewayRuleType.md} +0 -0
  126. data/docs/{NatGatewayRules.md → models/NatGatewayRules.md} +4 -4
  127. data/docs/{NatGateways.md → models/NatGateways.md} +6 -6
  128. data/docs/{NetworkLoadBalancer.md → models/NetworkLoadBalancer.md} +3 -3
  129. data/docs/{NetworkLoadBalancerEntities.md → models/NetworkLoadBalancerEntities.md} +0 -0
  130. data/docs/{NetworkLoadBalancerForwardingRule.md → models/NetworkLoadBalancerForwardingRule.md} +3 -3
  131. data/docs/{NetworkLoadBalancerForwardingRuleHealthCheck.md → models/NetworkLoadBalancerForwardingRuleHealthCheck.md} +0 -2
  132. data/docs/{NetworkLoadBalancerForwardingRuleProperties.md → models/NetworkLoadBalancerForwardingRuleProperties.md} +3 -3
  133. data/docs/{NetworkLoadBalancerForwardingRulePut.md → models/NetworkLoadBalancerForwardingRulePut.md} +3 -3
  134. data/docs/{NetworkLoadBalancerForwardingRuleTarget.md → models/NetworkLoadBalancerForwardingRuleTarget.md} +0 -0
  135. data/docs/{NetworkLoadBalancerForwardingRuleTargetHealthCheck.md → models/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md} +0 -0
  136. data/docs/{NetworkLoadBalancerForwardingRules.md → models/NetworkLoadBalancerForwardingRules.md} +6 -6
  137. data/docs/{NetworkLoadBalancerProperties.md → models/NetworkLoadBalancerProperties.md} +4 -4
  138. data/docs/{NetworkLoadBalancerPut.md → models/NetworkLoadBalancerPut.md} +3 -3
  139. data/docs/{NetworkLoadBalancers.md → models/NetworkLoadBalancers.md} +6 -6
  140. data/docs/{Nic.md → models/Nic.md} +3 -3
  141. data/docs/{NicEntities.md → models/NicEntities.md} +0 -0
  142. data/docs/models/NicProperties.md +34 -0
  143. data/docs/{NicPut.md → models/NicPut.md} +3 -3
  144. data/docs/{Nics.md → models/Nics.md} +6 -6
  145. data/docs/{NoStateMetaData.md → models/NoStateMetaData.md} +5 -5
  146. data/docs/{PaginationLinks.md → models/PaginationLinks.md} +3 -3
  147. data/docs/{Peer.md → models/Peer.md} +0 -0
  148. data/docs/{PrivateCrossConnect.md → models/PrivateCrossConnect.md} +3 -3
  149. data/docs/{PrivateCrossConnectProperties.md → models/PrivateCrossConnectProperties.md} +4 -4
  150. data/docs/{PrivateCrossConnects.md → models/PrivateCrossConnects.md} +4 -4
  151. data/docs/{RemoteConsoleUrl.md → models/RemoteConsoleUrl.md} +0 -0
  152. data/docs/{Request.md → models/Request.md} +3 -3
  153. data/docs/{RequestMetadata.md → models/RequestMetadata.md} +2 -2
  154. data/docs/{RequestProperties.md → models/RequestProperties.md} +0 -0
  155. data/docs/{RequestStatus.md → models/RequestStatus.md} +3 -3
  156. data/docs/{RequestStatusMetadata.md → models/RequestStatusMetadata.md} +1 -1
  157. data/docs/{RequestTarget.md → models/RequestTarget.md} +0 -0
  158. data/docs/{Requests.md → models/Requests.md} +6 -6
  159. data/docs/{Resource.md → models/Resource.md} +3 -3
  160. data/docs/{ResourceEntities.md → models/ResourceEntities.md} +0 -0
  161. data/docs/{ResourceGroups.md → models/ResourceGroups.md} +4 -4
  162. data/docs/models/ResourceLimits.md +60 -0
  163. data/docs/{ResourceProperties.md → models/ResourceProperties.md} +2 -2
  164. data/docs/{ResourceReference.md → models/ResourceReference.md} +3 -3
  165. data/docs/{Resources.md → models/Resources.md} +4 -4
  166. data/docs/{ResourcesUsers.md → models/ResourcesUsers.md} +4 -4
  167. data/docs/models/S3Bucket.md +18 -0
  168. data/docs/{S3Key.md → models/S3Key.md} +3 -3
  169. data/docs/{S3KeyMetadata.md → models/S3KeyMetadata.md} +2 -2
  170. data/docs/{S3KeyProperties.md → models/S3KeyProperties.md} +2 -2
  171. data/docs/{S3Keys.md → models/S3Keys.md} +4 -4
  172. data/docs/{S3ObjectStorageSSO.md → models/S3ObjectStorageSSO.md} +0 -0
  173. data/docs/{Server.md → models/Server.md} +3 -3
  174. data/docs/{ServerEntities.md → models/ServerEntities.md} +0 -0
  175. data/docs/{ServerProperties.md → models/ServerProperties.md} +7 -7
  176. data/docs/{Servers.md → models/Servers.md} +6 -6
  177. data/docs/{Snapshot.md → models/Snapshot.md} +3 -3
  178. data/docs/models/SnapshotProperties.md +48 -0
  179. data/docs/{Snapshots.md → models/Snapshots.md} +4 -4
  180. data/docs/{TargetPortRange.md → models/TargetPortRange.md} +2 -2
  181. data/docs/{Template.md → models/Template.md} +3 -3
  182. data/docs/{TemplateProperties.md → models/TemplateProperties.md} +4 -4
  183. data/docs/{Templates.md → models/Templates.md} +4 -4
  184. data/docs/{Token.md → models/Token.md} +1 -1
  185. data/docs/{Type.md → models/Type.md} +0 -0
  186. data/docs/{User.md → models/User.md} +3 -3
  187. data/docs/{UserMetadata.md → models/UserMetadata.md} +3 -3
  188. data/docs/{UserPost.md → models/UserPost.md} +0 -0
  189. data/docs/models/UserProperties.md +32 -0
  190. data/docs/models/UserPropertiesPost.md +32 -0
  191. data/docs/models/UserPropertiesPut.md +32 -0
  192. data/docs/{UserPut.md → models/UserPut.md} +1 -1
  193. data/docs/models/Users.md +30 -0
  194. data/docs/{UsersEntities.md → models/UsersEntities.md} +0 -0
  195. data/docs/{Volume.md → models/Volume.md} +3 -3
  196. data/docs/{VolumeProperties.md → models/VolumeProperties.md} +19 -17
  197. data/docs/{Volumes.md → models/Volumes.md} +6 -6
  198. data/docs/summary.md +192 -382
  199. data/ionoscloud.gemspec +3 -3
  200. data/lib/ionoscloud/api/_api.rb +8 -8
  201. data/lib/ionoscloud/api/backup_units_api.rb +98 -98
  202. data/lib/ionoscloud/api/contract_resources_api.rb +12 -12
  203. data/lib/ionoscloud/api/data_centers_api.rb +85 -85
  204. data/lib/ionoscloud/api/firewall_rules_api.rb +121 -121
  205. data/lib/ionoscloud/api/flow_logs_api.rb +107 -107
  206. data/lib/ionoscloud/api/images_api.rb +69 -69
  207. data/lib/ionoscloud/api/ip_blocks_api.rb +99 -81
  208. data/lib/ionoscloud/api/kubernetes_api.rb +237 -237
  209. data/lib/ionoscloud/api/labels_api.rb +419 -455
  210. data/lib/ionoscloud/api/lans_api.rb +220 -220
  211. data/lib/ionoscloud/api/load_balancers_api.rb +162 -198
  212. data/lib/ionoscloud/api/locations_api.rb +38 -38
  213. data/lib/ionoscloud/api/nat_gateways_api.rb +287 -305
  214. data/lib/ionoscloud/api/network_interfaces_api.rb +109 -109
  215. data/lib/ionoscloud/api/network_load_balancers_api.rb +301 -319
  216. data/lib/ionoscloud/api/private_cross_connects_api.rb +67 -85
  217. data/lib/ionoscloud/api/requests_api.rb +70 -46
  218. data/lib/ionoscloud/api/servers_api.rb +381 -381
  219. data/lib/ionoscloud/api/snapshots_api.rb +67 -67
  220. data/lib/ionoscloud/api/templates_api.rb +16 -16
  221. data/lib/ionoscloud/api/user_management_api.rb +350 -330
  222. data/lib/ionoscloud/api/user_s3_keys_api.rb +85 -85
  223. data/lib/ionoscloud/api/volumes_api.rb +140 -140
  224. data/lib/ionoscloud/api_client.rb +20 -20
  225. data/lib/ionoscloud/api_error.rb +2 -2
  226. data/lib/ionoscloud/configuration.rb +4 -4
  227. data/lib/ionoscloud/models/attached_volumes.rb +75 -19
  228. data/lib/ionoscloud/models/backup_unit.rb +52 -10
  229. data/lib/ionoscloud/models/backup_unit_properties.rb +33 -7
  230. data/lib/ionoscloud/models/backup_unit_sso.rb +13 -3
  231. data/lib/ionoscloud/models/backup_units.rb +48 -16
  232. data/lib/ionoscloud/models/balanced_nics.rb +75 -19
  233. data/lib/ionoscloud/models/cdroms.rb +75 -19
  234. data/lib/ionoscloud/models/connectable_datacenter.rb +31 -5
  235. data/lib/ionoscloud/models/contract.rb +23 -5
  236. data/lib/ionoscloud/models/contract_properties.rb +53 -11
  237. data/lib/ionoscloud/models/contracts.rb +45 -13
  238. data/lib/ionoscloud/models/cpu_architecture_properties.rb +41 -7
  239. data/lib/ionoscloud/models/data_center_entities.rb +58 -8
  240. data/lib/ionoscloud/models/datacenter.rb +61 -11
  241. data/lib/ionoscloud/models/datacenter_element_metadata.rb +82 -16
  242. data/lib/ionoscloud/models/datacenter_properties.rb +77 -45
  243. data/lib/ionoscloud/models/datacenters.rb +75 -19
  244. data/lib/ionoscloud/models/error.rb +25 -9
  245. data/lib/ionoscloud/models/error_message.rb +24 -6
  246. data/lib/ionoscloud/models/firewall_rule.rb +52 -10
  247. data/lib/ionoscloud/models/firewall_rules.rb +75 -19
  248. data/lib/ionoscloud/models/firewallrule_properties.rb +140 -43
  249. data/lib/ionoscloud/models/flow_log.rb +52 -10
  250. data/lib/ionoscloud/models/flow_log_properties.rb +41 -7
  251. data/lib/ionoscloud/models/flow_log_put.rb +43 -9
  252. data/lib/ionoscloud/models/flow_logs.rb +75 -19
  253. data/lib/ionoscloud/models/group.rb +52 -10
  254. data/lib/ionoscloud/models/group_entities.rb +22 -4
  255. data/lib/ionoscloud/models/group_members.rb +46 -14
  256. data/lib/ionoscloud/models/group_properties.rb +144 -28
  257. data/lib/ionoscloud/models/group_share.rb +42 -8
  258. data/lib/ionoscloud/models/group_share_properties.rb +22 -4
  259. data/lib/ionoscloud/models/group_shares.rb +45 -13
  260. data/lib/ionoscloud/models/group_users.rb +47 -15
  261. data/lib/ionoscloud/models/groups.rb +46 -14
  262. data/lib/ionoscloud/models/image.rb +52 -10
  263. data/lib/ionoscloud/models/image_properties.rb +226 -40
  264. data/lib/ionoscloud/models/images.rb +46 -14
  265. data/lib/ionoscloud/models/info.rb +31 -5
  266. data/lib/ionoscloud/models/ip_block.rb +52 -10
  267. data/lib/ionoscloud/models/ip_block_properties.rb +58 -20
  268. data/lib/ionoscloud/models/ip_blocks.rb +101 -16
  269. data/lib/ionoscloud/models/ip_consumer.rb +104 -12
  270. data/lib/ionoscloud/models/ip_failover.rb +22 -4
  271. data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +22 -4
  272. data/lib/ionoscloud/models/kubernetes_cluster.rb +60 -10
  273. data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +13 -3
  274. data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +60 -10
  275. data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +60 -10
  276. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +86 -34
  277. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +64 -24
  278. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +72 -10
  279. data/lib/ionoscloud/models/kubernetes_clusters.rb +46 -14
  280. data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +22 -4
  281. data/lib/ionoscloud/models/kubernetes_node.rb +51 -9
  282. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +53 -11
  283. data/lib/ionoscloud/models/kubernetes_node_pool.rb +51 -9
  284. data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +51 -9
  285. data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +51 -9
  286. data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +39 -10
  287. data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +22 -4
  288. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +182 -54
  289. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +170 -48
  290. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +97 -36
  291. data/lib/ionoscloud/models/kubernetes_node_pools.rb +46 -14
  292. data/lib/ionoscloud/models/kubernetes_node_properties.rb +42 -8
  293. data/lib/ionoscloud/models/kubernetes_nodes.rb +46 -14
  294. data/lib/ionoscloud/models/label.rb +51 -9
  295. data/lib/ionoscloud/models/label_properties.rb +52 -10
  296. data/lib/ionoscloud/models/label_resource.rb +51 -9
  297. data/lib/ionoscloud/models/label_resource_properties.rb +24 -6
  298. data/lib/ionoscloud/models/label_resources.rb +77 -21
  299. data/lib/ionoscloud/models/labels.rb +48 -16
  300. data/lib/ionoscloud/models/lan.rb +61 -11
  301. data/lib/ionoscloud/models/lan_entities.rb +13 -3
  302. data/lib/ionoscloud/models/lan_nics.rb +75 -19
  303. data/lib/ionoscloud/models/lan_post.rb +61 -11
  304. data/lib/ionoscloud/models/lan_properties.rb +45 -13
  305. data/lib/ionoscloud/models/lan_properties_post.rb +45 -13
  306. data/lib/ionoscloud/models/lans.rb +75 -19
  307. data/lib/ionoscloud/models/loadbalancer.rb +61 -11
  308. data/lib/ionoscloud/models/loadbalancer_entities.rb +13 -3
  309. data/lib/ionoscloud/models/loadbalancer_properties.rb +46 -37
  310. data/lib/ionoscloud/models/loadbalancers.rb +75 -19
  311. data/lib/ionoscloud/models/location.rb +52 -10
  312. data/lib/ionoscloud/models/location_properties.rb +47 -41
  313. data/lib/ionoscloud/models/locations.rb +46 -14
  314. data/lib/ionoscloud/models/nat_gateway.rb +61 -11
  315. data/lib/ionoscloud/models/nat_gateway_entities.rb +22 -4
  316. data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +26 -10
  317. data/lib/ionoscloud/models/nat_gateway_properties.rb +38 -16
  318. data/lib/ionoscloud/models/nat_gateway_put.rb +43 -9
  319. data/lib/ionoscloud/models/nat_gateway_rule.rb +52 -10
  320. data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +73 -15
  321. data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +2 -2
  322. data/lib/ionoscloud/models/nat_gateway_rule_put.rb +43 -9
  323. data/lib/ionoscloud/models/nat_gateway_rule_type.rb +2 -2
  324. data/lib/ionoscloud/models/nat_gateway_rules.rb +46 -14
  325. data/lib/ionoscloud/models/nat_gateways.rb +75 -19
  326. data/lib/ionoscloud/models/network_load_balancer.rb +61 -11
  327. data/lib/ionoscloud/models/network_load_balancer_entities.rb +22 -4
  328. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +52 -10
  329. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +39 -15
  330. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +73 -17
  331. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +43 -9
  332. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +40 -6
  333. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +31 -5
  334. data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +75 -19
  335. data/lib/ionoscloud/models/network_load_balancer_properties.rb +57 -19
  336. data/lib/ionoscloud/models/network_load_balancer_put.rb +43 -9
  337. data/lib/ionoscloud/models/network_load_balancers.rb +75 -19
  338. data/lib/ionoscloud/models/nic.rb +61 -11
  339. data/lib/ionoscloud/models/nic_entities.rb +22 -4
  340. data/lib/ionoscloud/models/nic_properties.rb +95 -23
  341. data/lib/ionoscloud/models/nic_put.rb +43 -9
  342. data/lib/ionoscloud/models/nics.rb +75 -19
  343. data/lib/ionoscloud/models/no_state_meta_data.rb +72 -14
  344. data/lib/ionoscloud/models/pagination_links.rb +34 -8
  345. data/lib/ionoscloud/models/peer.rb +49 -7
  346. data/lib/ionoscloud/models/private_cross_connect.rb +52 -10
  347. data/lib/ionoscloud/models/private_cross_connect_properties.rb +48 -18
  348. data/lib/ionoscloud/models/private_cross_connects.rb +46 -14
  349. data/lib/ionoscloud/models/remote_console_url.rb +13 -3
  350. data/lib/ionoscloud/models/request.rb +52 -10
  351. data/lib/ionoscloud/models/request_metadata.rb +42 -8
  352. data/lib/ionoscloud/models/request_properties.rb +42 -10
  353. data/lib/ionoscloud/models/request_status.rb +43 -9
  354. data/lib/ionoscloud/models/request_status_metadata.rb +43 -11
  355. data/lib/ionoscloud/models/request_target.rb +22 -4
  356. data/lib/ionoscloud/models/requests.rb +75 -19
  357. data/lib/ionoscloud/models/resource.rb +61 -11
  358. data/lib/ionoscloud/models/resource_entities.rb +13 -3
  359. data/lib/ionoscloud/models/resource_groups.rb +46 -14
  360. data/lib/ionoscloud/models/resource_limits.rb +224 -46
  361. data/lib/ionoscloud/models/resource_properties.rb +24 -6
  362. data/lib/ionoscloud/models/resource_reference.rb +34 -8
  363. data/lib/ionoscloud/models/resources.rb +47 -15
  364. data/lib/ionoscloud/models/resources_users.rb +46 -14
  365. data/lib/ionoscloud/models/s3_bucket.rb +232 -0
  366. data/lib/ionoscloud/models/s3_key.rb +52 -10
  367. data/lib/ionoscloud/models/s3_key_metadata.rb +24 -6
  368. data/lib/ionoscloud/models/s3_key_properties.rb +24 -6
  369. data/lib/ionoscloud/models/s3_keys.rb +46 -14
  370. data/lib/ionoscloud/models/s3_object_storage_sso.rb +13 -3
  371. data/lib/ionoscloud/models/server.rb +61 -11
  372. data/lib/ionoscloud/models/server_entities.rb +31 -5
  373. data/lib/ionoscloud/models/server_properties.rb +103 -21
  374. data/lib/ionoscloud/models/servers.rb +75 -19
  375. data/lib/ionoscloud/models/snapshot.rb +52 -10
  376. data/lib/ionoscloud/models/snapshot_properties.rb +162 -32
  377. data/lib/ionoscloud/models/snapshots.rb +46 -14
  378. data/lib/ionoscloud/models/target_port_range.rb +24 -6
  379. data/lib/ionoscloud/models/template.rb +52 -10
  380. data/lib/ionoscloud/models/template_properties.rb +44 -10
  381. data/lib/ionoscloud/models/templates.rb +46 -14
  382. data/lib/ionoscloud/models/token.rb +14 -4
  383. data/lib/ionoscloud/models/type.rb +4 -4
  384. data/lib/ionoscloud/models/user.rb +61 -11
  385. data/lib/ionoscloud/models/user_metadata.rb +34 -8
  386. data/lib/ionoscloud/models/user_post.rb +13 -3
  387. data/lib/ionoscloud/models/user_properties.rb +84 -18
  388. data/lib/ionoscloud/models/user_properties_post.rb +84 -18
  389. data/lib/ionoscloud/models/user_properties_put.rb +93 -17
  390. data/lib/ionoscloud/models/user_put.rb +23 -5
  391. data/lib/ionoscloud/models/users.rb +102 -17
  392. data/lib/ionoscloud/models/users_entities.rb +22 -4
  393. data/lib/ionoscloud/models/volume.rb +52 -10
  394. data/lib/ionoscloud/models/volume_properties.rb +216 -47
  395. data/lib/ionoscloud/models/volumes.rb +75 -19
  396. data/lib/ionoscloud/version.rb +3 -3
  397. data/lib/ionoscloud.rb +4 -3
  398. data/sonar-project.properties +12 -0
  399. data/spec/api_client_spec.rb +2 -2
  400. data/spec/configuration_spec.rb +2 -2
  401. data/spec/spec_helper.rb +2 -2
  402. metadata +207 -587
  403. data/docs/BackupUnitsApi.md +0 -595
  404. data/docs/DataCentersApi.md +0 -517
  405. data/docs/DefaultApi.md +0 -78
  406. data/docs/GroupProperties.md +0 -40
  407. data/docs/IPBlocksApi.md +0 -513
  408. data/docs/ImageProperties.md +0 -50
  409. data/docs/ImagesApi.md +0 -429
  410. data/docs/IpBlockProperties.md +0 -26
  411. data/docs/IpBlocks.md +0 -24
  412. data/docs/KubernetesClusterProperties.md +0 -30
  413. data/docs/KubernetesClusterPropertiesForPost.md +0 -26
  414. data/docs/KubernetesClusterPropertiesForPut.md +0 -22
  415. data/docs/LabelsApi.md +0 -2351
  416. data/docs/LansApi.md +0 -795
  417. data/docs/LocationsApi.md +0 -259
  418. data/docs/NetworkInterfacesApi.md +0 -541
  419. data/docs/NicProperties.md +0 -34
  420. data/docs/PrivateCrossConnectsApi.md +0 -431
  421. data/docs/RequestsApi.md +0 -267
  422. data/docs/ResourceLimits.md +0 -60
  423. data/docs/ServersApi.md +0 -1917
  424. data/docs/SnapshotProperties.md +0 -48
  425. data/docs/SnapshotsApi.md +0 -429
  426. data/docs/UserManagementApi.md +0 -2037
  427. data/docs/UserProperties.md +0 -32
  428. data/docs/UserPropertiesPost.md +0 -32
  429. data/docs/UserPropertiesPut.md +0 -30
  430. data/docs/UserS3KeysApi.md +0 -517
  431. data/docs/Users.md +0 -24
  432. data/docs/VolumesApi.md +0 -711
  433. data/spec/api/_api_spec.rb +0 -49
  434. data/spec/api/backup_units_api_spec.rb +0 -140
  435. data/spec/api/contract_resources_api_spec.rb +0 -49
  436. data/spec/api/data_centers_api_spec.rb +0 -128
  437. data/spec/api/firewall_rules_api_spec.rb +0 -146
  438. data/spec/api/flow_logs_api_spec.rb +0 -140
  439. data/spec/api/images_api_spec.rb +0 -111
  440. data/spec/api/ip_blocks_api_spec.rb +0 -126
  441. data/spec/api/kubernetes_api_spec.rb +0 -294
  442. data/spec/api/labels_api_spec.rb +0 -478
  443. data/spec/api/lans_api_spec.rb +0 -186
  444. data/spec/api/load_balancers_api_spec.rb +0 -205
  445. data/spec/api/locations_api_spec.rb +0 -80
  446. data/spec/api/nat_gateways_api_spec.rb +0 -336
  447. data/spec/api/network_interfaces_api_spec.rb +0 -140
  448. data/spec/api/network_load_balancers_api_spec.rb +0 -342
  449. data/spec/api/private_cross_connects_api_spec.rb +0 -112
  450. data/spec/api/requests_api_spec.rb +0 -84
  451. data/spec/api/servers_api_spec.rb +0 -401
  452. data/spec/api/snapshots_api_spec.rb +0 -111
  453. data/spec/api/templates_api_spec.rb +0 -60
  454. data/spec/api/user_management_api_spec.rb +0 -402
  455. data/spec/api/user_s3_keys_api_spec.rb +0 -128
  456. data/spec/api/volumes_api_spec.rb +0 -171
  457. data/spec/models/attached_volumes_spec.rb +0 -70
  458. data/spec/models/backup_unit_properties_spec.rb +0 -46
  459. data/spec/models/backup_unit_spec.rb +0 -62
  460. data/spec/models/backup_unit_sso_spec.rb +0 -34
  461. data/spec/models/backup_units_spec.rb +0 -56
  462. data/spec/models/balanced_nics_spec.rb +0 -70
  463. data/spec/models/cdroms_spec.rb +0 -70
  464. data/spec/models/connectable_datacenter_spec.rb +0 -46
  465. data/spec/models/contract_properties_spec.rb +0 -58
  466. data/spec/models/contract_spec.rb +0 -40
  467. data/spec/models/contracts_spec.rb +0 -52
  468. data/spec/models/cpu_architecture_properties_spec.rb +0 -52
  469. data/spec/models/data_center_entities_spec.rb +0 -64
  470. data/spec/models/datacenter_element_metadata_spec.rb +0 -80
  471. data/spec/models/datacenter_properties_spec.rb +0 -74
  472. data/spec/models/datacenter_spec.rb +0 -64
  473. data/spec/models/datacenters_spec.rb +0 -70
  474. data/spec/models/error_message_spec.rb +0 -40
  475. data/spec/models/error_spec.rb +0 -40
  476. data/spec/models/firewall_rule_spec.rb +0 -58
  477. data/spec/models/firewall_rules_spec.rb +0 -70
  478. data/spec/models/firewallrule_properties_spec.rb +0 -108
  479. data/spec/models/flow_log_properties_spec.rb +0 -60
  480. data/spec/models/flow_log_put_spec.rb +0 -52
  481. data/spec/models/flow_log_spec.rb +0 -58
  482. data/spec/models/flow_logs_spec.rb +0 -70
  483. data/spec/models/group_entities_spec.rb +0 -40
  484. data/spec/models/group_members_spec.rb +0 -52
  485. data/spec/models/group_properties_spec.rb +0 -100
  486. data/spec/models/group_share_properties_spec.rb +0 -40
  487. data/spec/models/group_share_spec.rb +0 -52
  488. data/spec/models/group_shares_spec.rb +0 -52
  489. data/spec/models/group_spec.rb +0 -58
  490. data/spec/models/group_users_spec.rb +0 -52
  491. data/spec/models/groups_spec.rb +0 -52
  492. data/spec/models/image_properties_spec.rb +0 -138
  493. data/spec/models/image_spec.rb +0 -58
  494. data/spec/models/images_spec.rb +0 -52
  495. data/spec/models/info_spec.rb +0 -46
  496. data/spec/models/ip_block_properties_spec.rb +0 -58
  497. data/spec/models/ip_block_spec.rb +0 -58
  498. data/spec/models/ip_blocks_spec.rb +0 -52
  499. data/spec/models/ip_consumer_spec.rb +0 -70
  500. data/spec/models/ip_failover_spec.rb +0 -40
  501. data/spec/models/kubernetes_auto_scaling_spec.rb +0 -40
  502. data/spec/models/kubernetes_cluster_entities_spec.rb +0 -34
  503. data/spec/models/kubernetes_cluster_for_post_spec.rb +0 -68
  504. data/spec/models/kubernetes_cluster_for_put_spec.rb +0 -68
  505. data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +0 -58
  506. data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +0 -46
  507. data/spec/models/kubernetes_cluster_properties_spec.rb +0 -70
  508. data/spec/models/kubernetes_cluster_spec.rb +0 -68
  509. data/spec/models/kubernetes_clusters_spec.rb +0 -56
  510. data/spec/models/kubernetes_maintenance_window_spec.rb +0 -44
  511. data/spec/models/kubernetes_node_metadata_spec.rb +0 -62
  512. data/spec/models/kubernetes_node_pool_for_post_spec.rb +0 -62
  513. data/spec/models/kubernetes_node_pool_for_put_spec.rb +0 -62
  514. data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +0 -40
  515. data/spec/models/kubernetes_node_pool_lan_spec.rb +0 -46
  516. data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +0 -132
  517. data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +0 -82
  518. data/spec/models/kubernetes_node_pool_properties_spec.rb +0 -138
  519. data/spec/models/kubernetes_node_pool_spec.rb +0 -62
  520. data/spec/models/kubernetes_node_pools_spec.rb +0 -56
  521. data/spec/models/kubernetes_node_properties_spec.rb +0 -52
  522. data/spec/models/kubernetes_node_spec.rb +0 -62
  523. data/spec/models/kubernetes_nodes_spec.rb +0 -56
  524. data/spec/models/label_properties_spec.rb +0 -58
  525. data/spec/models/label_resource_properties_spec.rb +0 -40
  526. data/spec/models/label_resource_spec.rb +0 -62
  527. data/spec/models/label_resources_spec.rb +0 -74
  528. data/spec/models/label_spec.rb +0 -62
  529. data/spec/models/labels_spec.rb +0 -56
  530. data/spec/models/lan_entities_spec.rb +0 -34
  531. data/spec/models/lan_nics_spec.rb +0 -70
  532. data/spec/models/lan_post_spec.rb +0 -64
  533. data/spec/models/lan_properties_post_spec.rb +0 -52
  534. data/spec/models/lan_properties_spec.rb +0 -52
  535. data/spec/models/lan_spec.rb +0 -64
  536. data/spec/models/lans_spec.rb +0 -70
  537. data/spec/models/loadbalancer_entities_spec.rb +0 -34
  538. data/spec/models/loadbalancer_properties_spec.rb +0 -50
  539. data/spec/models/loadbalancer_spec.rb +0 -64
  540. data/spec/models/loadbalancers_spec.rb +0 -70
  541. data/spec/models/location_properties_spec.rb +0 -56
  542. data/spec/models/location_spec.rb +0 -58
  543. data/spec/models/locations_spec.rb +0 -52
  544. data/spec/models/nat_gateway_entities_spec.rb +0 -40
  545. data/spec/models/nat_gateway_lan_properties_spec.rb +0 -40
  546. data/spec/models/nat_gateway_properties_spec.rb +0 -46
  547. data/spec/models/nat_gateway_put_spec.rb +0 -52
  548. data/spec/models/nat_gateway_rule_properties_spec.rb +0 -70
  549. data/spec/models/nat_gateway_rule_protocol_spec.rb +0 -28
  550. data/spec/models/nat_gateway_rule_put_spec.rb +0 -52
  551. data/spec/models/nat_gateway_rule_spec.rb +0 -58
  552. data/spec/models/nat_gateway_rule_type_spec.rb +0 -28
  553. data/spec/models/nat_gateway_rules_spec.rb +0 -52
  554. data/spec/models/nat_gateway_spec.rb +0 -64
  555. data/spec/models/nat_gateways_spec.rb +0 -70
  556. data/spec/models/network_load_balancer_entities_spec.rb +0 -40
  557. data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +0 -58
  558. data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +0 -78
  559. data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +0 -52
  560. data/spec/models/network_load_balancer_forwarding_rule_spec.rb +0 -58
  561. data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +0 -46
  562. data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +0 -52
  563. data/spec/models/network_load_balancer_forwarding_rules_spec.rb +0 -70
  564. data/spec/models/network_load_balancer_properties_spec.rb +0 -58
  565. data/spec/models/network_load_balancer_put_spec.rb +0 -52
  566. data/spec/models/network_load_balancer_spec.rb +0 -64
  567. data/spec/models/network_load_balancers_spec.rb +0 -70
  568. data/spec/models/nic_entities_spec.rb +0 -40
  569. data/spec/models/nic_properties_spec.rb +0 -86
  570. data/spec/models/nic_put_spec.rb +0 -52
  571. data/spec/models/nic_spec.rb +0 -64
  572. data/spec/models/nics_spec.rb +0 -70
  573. data/spec/models/no_state_meta_data_spec.rb +0 -70
  574. data/spec/models/pagination_links_spec.rb +0 -46
  575. data/spec/models/peer_spec.rb +0 -58
  576. data/spec/models/private_cross_connect_properties_spec.rb +0 -52
  577. data/spec/models/private_cross_connect_spec.rb +0 -58
  578. data/spec/models/private_cross_connects_spec.rb +0 -52
  579. data/spec/models/remote_console_url_spec.rb +0 -34
  580. data/spec/models/request_metadata_spec.rb +0 -52
  581. data/spec/models/request_properties_spec.rb +0 -52
  582. data/spec/models/request_spec.rb +0 -58
  583. data/spec/models/request_status_metadata_spec.rb +0 -56
  584. data/spec/models/request_status_spec.rb +0 -52
  585. data/spec/models/request_target_spec.rb +0 -44
  586. data/spec/models/requests_spec.rb +0 -70
  587. data/spec/models/resource_entities_spec.rb +0 -34
  588. data/spec/models/resource_groups_spec.rb +0 -52
  589. data/spec/models/resource_limits_spec.rb +0 -160
  590. data/spec/models/resource_properties_spec.rb +0 -40
  591. data/spec/models/resource_reference_spec.rb +0 -46
  592. data/spec/models/resource_spec.rb +0 -64
  593. data/spec/models/resources_spec.rb +0 -52
  594. data/spec/models/resources_users_spec.rb +0 -52
  595. data/spec/models/s3_key_metadata_spec.rb +0 -40
  596. data/spec/models/s3_key_properties_spec.rb +0 -40
  597. data/spec/models/s3_key_spec.rb +0 -58
  598. data/spec/models/s3_keys_spec.rb +0 -52
  599. data/spec/models/s3_object_storage_sso_spec.rb +0 -34
  600. data/spec/models/server_entities_spec.rb +0 -46
  601. data/spec/models/server_properties_spec.rb +0 -96
  602. data/spec/models/server_spec.rb +0 -64
  603. data/spec/models/servers_spec.rb +0 -70
  604. data/spec/models/snapshot_properties_spec.rb +0 -128
  605. data/spec/models/snapshot_spec.rb +0 -58
  606. data/spec/models/snapshots_spec.rb +0 -52
  607. data/spec/models/target_port_range_spec.rb +0 -40
  608. data/spec/models/template_properties_spec.rb +0 -52
  609. data/spec/models/template_spec.rb +0 -58
  610. data/spec/models/templates_spec.rb +0 -52
  611. data/spec/models/token_spec.rb +0 -34
  612. data/spec/models/type_spec.rb +0 -28
  613. data/spec/models/user_metadata_spec.rb +0 -46
  614. data/spec/models/user_post_spec.rb +0 -34
  615. data/spec/models/user_properties_post_spec.rb +0 -76
  616. data/spec/models/user_properties_put_spec.rb +0 -70
  617. data/spec/models/user_properties_spec.rb +0 -76
  618. data/spec/models/user_put_spec.rb +0 -40
  619. data/spec/models/user_spec.rb +0 -64
  620. data/spec/models/users_entities_spec.rb +0 -40
  621. data/spec/models/users_spec.rb +0 -52
  622. data/spec/models/volume_properties_spec.rb +0 -158
  623. data/spec/models/volume_spec.rb +0 -58
  624. data/spec/models/volumes_spec.rb +0 -70
data/docs/ServersApi.md DELETED
@@ -1,1917 +0,0 @@
1
- # ServersApi
2
-
3
- All URIs are relative to *https://api.ionos.com/cloudapi/v6*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**datacenters_servers_cdroms_delete**](ServersApi.md#datacenters_servers_cdroms_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Detach a CD-ROM |
8
- | [**datacenters_servers_cdroms_find_by_id**](ServersApi.md#datacenters_servers_cdroms_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Retrieve an attached CD-ROM |
9
- | [**datacenters_servers_cdroms_get**](ServersApi.md#datacenters_servers_cdroms_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/cdroms | List attached CD-ROMs |
10
- | [**datacenters_servers_cdroms_post**](ServersApi.md#datacenters_servers_cdroms_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/cdroms | Attach a CD-ROM |
11
- | [**datacenters_servers_delete**](ServersApi.md#datacenters_servers_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId} | Delete a Server |
12
- | [**datacenters_servers_find_by_id**](ServersApi.md#datacenters_servers_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId} | Retrieve a Server |
13
- | [**datacenters_servers_get**](ServersApi.md#datacenters_servers_get) | **GET** /datacenters/{datacenterId}/servers | List Servers |
14
- | [**datacenters_servers_patch**](ServersApi.md#datacenters_servers_patch) | **PATCH** /datacenters/{datacenterId}/servers/{serverId} | Partially modify a Server |
15
- | [**datacenters_servers_post**](ServersApi.md#datacenters_servers_post) | **POST** /datacenters/{datacenterId}/servers | Create a Server |
16
- | [**datacenters_servers_put**](ServersApi.md#datacenters_servers_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId} | Modify a Server |
17
- | [**datacenters_servers_reboot_post**](ServersApi.md#datacenters_servers_reboot_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/reboot | Reboot a Server |
18
- | [**datacenters_servers_remote_console_get**](ServersApi.md#datacenters_servers_remote_console_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/remoteconsole | Get the server remote console link |
19
- | [**datacenters_servers_resume_post**](ServersApi.md#datacenters_servers_resume_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/resume | Resume a Cube Server |
20
- | [**datacenters_servers_start_post**](ServersApi.md#datacenters_servers_start_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/start | Start a Server |
21
- | [**datacenters_servers_stop_post**](ServersApi.md#datacenters_servers_stop_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/stop | Stop a Server |
22
- | [**datacenters_servers_suspend_post**](ServersApi.md#datacenters_servers_suspend_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/suspend | Suspend a Cube Server |
23
- | [**datacenters_servers_token_get**](ServersApi.md#datacenters_servers_token_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/token | Get the server's jwToken |
24
- | [**datacenters_servers_upgrade_post**](ServersApi.md#datacenters_servers_upgrade_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/upgrade | Upgrade a Server |
25
- | [**datacenters_servers_volumes_delete**](ServersApi.md#datacenters_servers_volumes_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Detach a volume |
26
- | [**datacenters_servers_volumes_find_by_id**](ServersApi.md#datacenters_servers_volumes_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Retrieve an attached volume |
27
- | [**datacenters_servers_volumes_get**](ServersApi.md#datacenters_servers_volumes_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes | List Attached Volumes |
28
- | [**datacenters_servers_volumes_post**](ServersApi.md#datacenters_servers_volumes_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/volumes | Attach a volume |
29
-
30
-
31
- ## datacenters_servers_cdroms_delete
32
-
33
- > Object datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, opts)
34
-
35
- Detach a CD-ROM
36
-
37
- This will detach a CD-ROM from the server
38
-
39
- ### Examples
40
-
41
- ```ruby
42
- require 'time'
43
- require 'ionoscloud'
44
- # setup authorization
45
- Ionoscloud.configure do |config|
46
- # Configure HTTP basic authorization: Basic Authentication
47
- config.username = 'YOUR USERNAME'
48
- config.password = 'YOUR PASSWORD'
49
-
50
- # Configure API key authorization: Token Authentication
51
- config.api_key['Authorization'] = 'YOUR API KEY'
52
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
53
- # config.api_key_prefix['Authorization'] = 'Bearer'
54
- end
55
-
56
- api_instance = Ionoscloud::ServersApi.new
57
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
58
- server_id = 'server_id_example' # String | The unique ID of the Server
59
- cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM
60
- opts = {
61
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
62
- 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
63
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
64
- }
65
-
66
- begin
67
- # Detach a CD-ROM
68
- result = api_instance.datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, opts)
69
- p result
70
- rescue Ionoscloud::ApiError => e
71
- puts "Error when calling ServersApi->datacenters_servers_cdroms_delete: #{e}"
72
- end
73
- ```
74
-
75
- #### Using the datacenters_servers_cdroms_delete_with_http_info variant
76
-
77
- This returns an Array which contains the response data, status code and headers.
78
-
79
- > <Array(Object, Integer, Hash)> datacenters_servers_cdroms_delete_with_http_info(datacenter_id, server_id, cdrom_id, opts)
80
-
81
- ```ruby
82
- begin
83
- # Detach a CD-ROM
84
- data, status_code, headers = api_instance.datacenters_servers_cdroms_delete_with_http_info(datacenter_id, server_id, cdrom_id, opts)
85
- p status_code # => 2xx
86
- p headers # => { ... }
87
- p data # => Object
88
- rescue Ionoscloud::ApiError => e
89
- puts "Error when calling ServersApi->datacenters_servers_cdroms_delete_with_http_info: #{e}"
90
- end
91
- ```
92
-
93
- ### Parameters
94
-
95
- | Name | Type | Description | Notes |
96
- | ---- | ---- | ----------- | ----- |
97
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
98
- | **server_id** | **String** | The unique ID of the Server | |
99
- | **cdrom_id** | **String** | The unique ID of the CD-ROM | |
100
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
101
- | **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] |
102
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
103
-
104
- ### Return type
105
-
106
- **Object**
107
-
108
- ### Authorization
109
-
110
- Basic Authentication, Token Authentication
111
-
112
- ### HTTP request headers
113
-
114
- - **Content-Type**: Not defined
115
- - **Accept**: application/json
116
-
117
-
118
- ## datacenters_servers_cdroms_find_by_id
119
-
120
- > <Image> datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, opts)
121
-
122
- Retrieve an attached CD-ROM
123
-
124
- You can retrieve a specific CD-ROM attached to the server
125
-
126
- ### Examples
127
-
128
- ```ruby
129
- require 'time'
130
- require 'ionoscloud'
131
- # setup authorization
132
- Ionoscloud.configure do |config|
133
- # Configure HTTP basic authorization: Basic Authentication
134
- config.username = 'YOUR USERNAME'
135
- config.password = 'YOUR PASSWORD'
136
-
137
- # Configure API key authorization: Token Authentication
138
- config.api_key['Authorization'] = 'YOUR API KEY'
139
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
140
- # config.api_key_prefix['Authorization'] = 'Bearer'
141
- end
142
-
143
- api_instance = Ionoscloud::ServersApi.new
144
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
145
- server_id = 'server_id_example' # String | The unique ID of the Server
146
- cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM
147
- opts = {
148
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
149
- 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
150
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
151
- }
152
-
153
- begin
154
- # Retrieve an attached CD-ROM
155
- result = api_instance.datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, opts)
156
- p result
157
- rescue Ionoscloud::ApiError => e
158
- puts "Error when calling ServersApi->datacenters_servers_cdroms_find_by_id: #{e}"
159
- end
160
- ```
161
-
162
- #### Using the datacenters_servers_cdroms_find_by_id_with_http_info variant
163
-
164
- This returns an Array which contains the response data, status code and headers.
165
-
166
- > <Array(<Image>, Integer, Hash)> datacenters_servers_cdroms_find_by_id_with_http_info(datacenter_id, server_id, cdrom_id, opts)
167
-
168
- ```ruby
169
- begin
170
- # Retrieve an attached CD-ROM
171
- data, status_code, headers = api_instance.datacenters_servers_cdroms_find_by_id_with_http_info(datacenter_id, server_id, cdrom_id, opts)
172
- p status_code # => 2xx
173
- p headers # => { ... }
174
- p data # => <Image>
175
- rescue Ionoscloud::ApiError => e
176
- puts "Error when calling ServersApi->datacenters_servers_cdroms_find_by_id_with_http_info: #{e}"
177
- end
178
- ```
179
-
180
- ### Parameters
181
-
182
- | Name | Type | Description | Notes |
183
- | ---- | ---- | ----------- | ----- |
184
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
185
- | **server_id** | **String** | The unique ID of the Server | |
186
- | **cdrom_id** | **String** | The unique ID of the CD-ROM | |
187
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
188
- | **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] |
189
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
190
-
191
- ### Return type
192
-
193
- [**Image**](Image.md)
194
-
195
- ### Authorization
196
-
197
- Basic Authentication, Token Authentication
198
-
199
- ### HTTP request headers
200
-
201
- - **Content-Type**: Not defined
202
- - **Accept**: application/json
203
-
204
-
205
- ## datacenters_servers_cdroms_get
206
-
207
- > <Cdroms> datacenters_servers_cdroms_get(datacenter_id, server_id, opts)
208
-
209
- List attached CD-ROMs
210
-
211
- You can retrieve a list of CD-ROMs attached to the server.
212
-
213
- ### Examples
214
-
215
- ```ruby
216
- require 'time'
217
- require 'ionoscloud'
218
- # setup authorization
219
- Ionoscloud.configure do |config|
220
- # Configure HTTP basic authorization: Basic Authentication
221
- config.username = 'YOUR USERNAME'
222
- config.password = 'YOUR PASSWORD'
223
-
224
- # Configure API key authorization: Token Authentication
225
- config.api_key['Authorization'] = 'YOUR API KEY'
226
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
227
- # config.api_key_prefix['Authorization'] = 'Bearer'
228
- end
229
-
230
- api_instance = Ionoscloud::ServersApi.new
231
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
232
- server_id = 'server_id_example' # String | The unique ID of the Server
233
- opts = {
234
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
235
- 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
236
- x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
237
- offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with limit for pagination)
238
- limit: 56 # Integer | the maximum number of elements to return (use together with offset for pagination)
239
- }
240
-
241
- begin
242
- # List attached CD-ROMs
243
- result = api_instance.datacenters_servers_cdroms_get(datacenter_id, server_id, opts)
244
- p result
245
- rescue Ionoscloud::ApiError => e
246
- puts "Error when calling ServersApi->datacenters_servers_cdroms_get: #{e}"
247
- end
248
- ```
249
-
250
- #### Using the datacenters_servers_cdroms_get_with_http_info variant
251
-
252
- This returns an Array which contains the response data, status code and headers.
253
-
254
- > <Array(<Cdroms>, Integer, Hash)> datacenters_servers_cdroms_get_with_http_info(datacenter_id, server_id, opts)
255
-
256
- ```ruby
257
- begin
258
- # List attached CD-ROMs
259
- data, status_code, headers = api_instance.datacenters_servers_cdroms_get_with_http_info(datacenter_id, server_id, opts)
260
- p status_code # => 2xx
261
- p headers # => { ... }
262
- p data # => <Cdroms>
263
- rescue Ionoscloud::ApiError => e
264
- puts "Error when calling ServersApi->datacenters_servers_cdroms_get_with_http_info: #{e}"
265
- end
266
- ```
267
-
268
- ### Parameters
269
-
270
- | Name | Type | Description | Notes |
271
- | ---- | ---- | ----------- | ----- |
272
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
273
- | **server_id** | **String** | The unique ID of the Server | |
274
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
275
- | **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] |
276
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
277
- | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with limit for pagination) | [optional][default to 0] |
278
- | **limit** | **Integer** | the maximum number of elements to return (use together with offset for pagination) | [optional][default to 1000] |
279
-
280
- ### Return type
281
-
282
- [**Cdroms**](Cdroms.md)
283
-
284
- ### Authorization
285
-
286
- Basic Authentication, Token Authentication
287
-
288
- ### HTTP request headers
289
-
290
- - **Content-Type**: Not defined
291
- - **Accept**: application/json
292
-
293
-
294
- ## datacenters_servers_cdroms_post
295
-
296
- > <Image> datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, opts)
297
-
298
- Attach a CD-ROM
299
-
300
- You can attach a CD-ROM to an existing server. You can attach up to 2 CD-ROMs to one server.
301
-
302
- ### Examples
303
-
304
- ```ruby
305
- require 'time'
306
- require 'ionoscloud'
307
- # setup authorization
308
- Ionoscloud.configure do |config|
309
- # Configure HTTP basic authorization: Basic Authentication
310
- config.username = 'YOUR USERNAME'
311
- config.password = 'YOUR PASSWORD'
312
-
313
- # Configure API key authorization: Token Authentication
314
- config.api_key['Authorization'] = 'YOUR API KEY'
315
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
316
- # config.api_key_prefix['Authorization'] = 'Bearer'
317
- end
318
-
319
- api_instance = Ionoscloud::ServersApi.new
320
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
321
- server_id = 'server_id_example' # String | The unique ID of the Server
322
- cdrom = Ionoscloud::Image.new({properties: Ionoscloud::ImageProperties.new({licence_type: 'UNKNOWN'})}) # Image | CD-ROM to be attached
323
- opts = {
324
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
325
- 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
326
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
327
- }
328
-
329
- begin
330
- # Attach a CD-ROM
331
- result = api_instance.datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, opts)
332
- p result
333
- rescue Ionoscloud::ApiError => e
334
- puts "Error when calling ServersApi->datacenters_servers_cdroms_post: #{e}"
335
- end
336
- ```
337
-
338
- #### Using the datacenters_servers_cdroms_post_with_http_info variant
339
-
340
- This returns an Array which contains the response data, status code and headers.
341
-
342
- > <Array(<Image>, Integer, Hash)> datacenters_servers_cdroms_post_with_http_info(datacenter_id, server_id, cdrom, opts)
343
-
344
- ```ruby
345
- begin
346
- # Attach a CD-ROM
347
- data, status_code, headers = api_instance.datacenters_servers_cdroms_post_with_http_info(datacenter_id, server_id, cdrom, opts)
348
- p status_code # => 2xx
349
- p headers # => { ... }
350
- p data # => <Image>
351
- rescue Ionoscloud::ApiError => e
352
- puts "Error when calling ServersApi->datacenters_servers_cdroms_post_with_http_info: #{e}"
353
- end
354
- ```
355
-
356
- ### Parameters
357
-
358
- | Name | Type | Description | Notes |
359
- | ---- | ---- | ----------- | ----- |
360
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
361
- | **server_id** | **String** | The unique ID of the Server | |
362
- | **cdrom** | [**Image**](Image.md) | CD-ROM to be attached | |
363
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
364
- | **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] |
365
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
366
-
367
- ### Return type
368
-
369
- [**Image**](Image.md)
370
-
371
- ### Authorization
372
-
373
- Basic Authentication, Token Authentication
374
-
375
- ### HTTP request headers
376
-
377
- - **Content-Type**: application/json
378
- - **Accept**: application/json
379
-
380
-
381
- ## datacenters_servers_delete
382
-
383
- > Object datacenters_servers_delete(datacenter_id, server_id, opts)
384
-
385
- Delete a Server
386
-
387
- 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
388
-
389
- ### Examples
390
-
391
- ```ruby
392
- require 'time'
393
- require 'ionoscloud'
394
- # setup authorization
395
- Ionoscloud.configure do |config|
396
- # Configure HTTP basic authorization: Basic Authentication
397
- config.username = 'YOUR USERNAME'
398
- config.password = 'YOUR PASSWORD'
399
-
400
- # Configure API key authorization: Token Authentication
401
- config.api_key['Authorization'] = 'YOUR API KEY'
402
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
403
- # config.api_key_prefix['Authorization'] = 'Bearer'
404
- end
405
-
406
- api_instance = Ionoscloud::ServersApi.new
407
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
408
- server_id = 'server_id_example' # String | The unique ID of the Server
409
- opts = {
410
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
411
- 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
412
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
413
- }
414
-
415
- begin
416
- # Delete a Server
417
- result = api_instance.datacenters_servers_delete(datacenter_id, server_id, opts)
418
- p result
419
- rescue Ionoscloud::ApiError => e
420
- puts "Error when calling ServersApi->datacenters_servers_delete: #{e}"
421
- end
422
- ```
423
-
424
- #### Using the datacenters_servers_delete_with_http_info variant
425
-
426
- This returns an Array which contains the response data, status code and headers.
427
-
428
- > <Array(Object, Integer, Hash)> datacenters_servers_delete_with_http_info(datacenter_id, server_id, opts)
429
-
430
- ```ruby
431
- begin
432
- # Delete a Server
433
- data, status_code, headers = api_instance.datacenters_servers_delete_with_http_info(datacenter_id, server_id, opts)
434
- p status_code # => 2xx
435
- p headers # => { ... }
436
- p data # => Object
437
- rescue Ionoscloud::ApiError => e
438
- puts "Error when calling ServersApi->datacenters_servers_delete_with_http_info: #{e}"
439
- end
440
- ```
441
-
442
- ### Parameters
443
-
444
- | Name | Type | Description | Notes |
445
- | ---- | ---- | ----------- | ----- |
446
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
447
- | **server_id** | **String** | The unique ID of the Server | |
448
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
449
- | **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] |
450
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
451
-
452
- ### Return type
453
-
454
- **Object**
455
-
456
- ### Authorization
457
-
458
- Basic Authentication, Token Authentication
459
-
460
- ### HTTP request headers
461
-
462
- - **Content-Type**: Not defined
463
- - **Accept**: application/json
464
-
465
-
466
- ## datacenters_servers_find_by_id
467
-
468
- > <Server> datacenters_servers_find_by_id(datacenter_id, server_id, opts)
469
-
470
- Retrieve a Server
471
-
472
- Returns information about a server such as its configuration, provisioning status, etc.
473
-
474
- ### Examples
475
-
476
- ```ruby
477
- require 'time'
478
- require 'ionoscloud'
479
- # setup authorization
480
- Ionoscloud.configure do |config|
481
- # Configure HTTP basic authorization: Basic Authentication
482
- config.username = 'YOUR USERNAME'
483
- config.password = 'YOUR PASSWORD'
484
-
485
- # Configure API key authorization: Token Authentication
486
- config.api_key['Authorization'] = 'YOUR API KEY'
487
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
488
- # config.api_key_prefix['Authorization'] = 'Bearer'
489
- end
490
-
491
- api_instance = Ionoscloud::ServersApi.new
492
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
493
- server_id = 'server_id_example' # String | The unique ID of the Server
494
- opts = {
495
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
496
- 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
497
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
498
- }
499
-
500
- begin
501
- # Retrieve a Server
502
- result = api_instance.datacenters_servers_find_by_id(datacenter_id, server_id, opts)
503
- p result
504
- rescue Ionoscloud::ApiError => e
505
- puts "Error when calling ServersApi->datacenters_servers_find_by_id: #{e}"
506
- end
507
- ```
508
-
509
- #### Using the datacenters_servers_find_by_id_with_http_info variant
510
-
511
- This returns an Array which contains the response data, status code and headers.
512
-
513
- > <Array(<Server>, Integer, Hash)> datacenters_servers_find_by_id_with_http_info(datacenter_id, server_id, opts)
514
-
515
- ```ruby
516
- begin
517
- # Retrieve a Server
518
- data, status_code, headers = api_instance.datacenters_servers_find_by_id_with_http_info(datacenter_id, server_id, opts)
519
- p status_code # => 2xx
520
- p headers # => { ... }
521
- p data # => <Server>
522
- rescue Ionoscloud::ApiError => e
523
- puts "Error when calling ServersApi->datacenters_servers_find_by_id_with_http_info: #{e}"
524
- end
525
- ```
526
-
527
- ### Parameters
528
-
529
- | Name | Type | Description | Notes |
530
- | ---- | ---- | ----------- | ----- |
531
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
532
- | **server_id** | **String** | The unique ID of the Server | |
533
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
534
- | **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] |
535
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
536
-
537
- ### Return type
538
-
539
- [**Server**](Server.md)
540
-
541
- ### Authorization
542
-
543
- Basic Authentication, Token Authentication
544
-
545
- ### HTTP request headers
546
-
547
- - **Content-Type**: Not defined
548
- - **Accept**: application/json
549
-
550
-
551
- ## datacenters_servers_get
552
-
553
- > <Servers> datacenters_servers_get(datacenter_id, opts)
554
-
555
- List Servers
556
-
557
- You can retrieve a list of servers within a datacenter
558
-
559
- ### Examples
560
-
561
- ```ruby
562
- require 'time'
563
- require 'ionoscloud'
564
- # setup authorization
565
- Ionoscloud.configure do |config|
566
- # Configure HTTP basic authorization: Basic Authentication
567
- config.username = 'YOUR USERNAME'
568
- config.password = 'YOUR PASSWORD'
569
-
570
- # Configure API key authorization: Token Authentication
571
- config.api_key['Authorization'] = 'YOUR API KEY'
572
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
573
- # config.api_key_prefix['Authorization'] = 'Bearer'
574
- end
575
-
576
- api_instance = Ionoscloud::ServersApi.new
577
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
578
- opts = {
579
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
580
- 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
581
- upgrade_needed: true, # Boolean | It can be used to filter which servers can be upgraded which can not be upgraded.
582
- x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
583
- offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with limit for pagination)
584
- limit: 56 # Integer | the maximum number of elements to return (use together with offset for pagination)
585
- }
586
-
587
- begin
588
- # List Servers
589
- result = api_instance.datacenters_servers_get(datacenter_id, opts)
590
- p result
591
- rescue Ionoscloud::ApiError => e
592
- puts "Error when calling ServersApi->datacenters_servers_get: #{e}"
593
- end
594
- ```
595
-
596
- #### Using the datacenters_servers_get_with_http_info variant
597
-
598
- This returns an Array which contains the response data, status code and headers.
599
-
600
- > <Array(<Servers>, Integer, Hash)> datacenters_servers_get_with_http_info(datacenter_id, opts)
601
-
602
- ```ruby
603
- begin
604
- # List Servers
605
- data, status_code, headers = api_instance.datacenters_servers_get_with_http_info(datacenter_id, opts)
606
- p status_code # => 2xx
607
- p headers # => { ... }
608
- p data # => <Servers>
609
- rescue Ionoscloud::ApiError => e
610
- puts "Error when calling ServersApi->datacenters_servers_get_with_http_info: #{e}"
611
- end
612
- ```
613
-
614
- ### Parameters
615
-
616
- | Name | Type | Description | Notes |
617
- | ---- | ---- | ----------- | ----- |
618
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
619
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
620
- | **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] |
621
- | **upgrade_needed** | **Boolean** | It can be used to filter which servers can be upgraded which can not be upgraded. | [optional] |
622
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
623
- | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with limit for pagination) | [optional][default to 0] |
624
- | **limit** | **Integer** | the maximum number of elements to return (use together with offset for pagination) | [optional][default to 1000] |
625
-
626
- ### Return type
627
-
628
- [**Servers**](Servers.md)
629
-
630
- ### Authorization
631
-
632
- Basic Authentication, Token Authentication
633
-
634
- ### HTTP request headers
635
-
636
- - **Content-Type**: Not defined
637
- - **Accept**: application/json
638
-
639
-
640
- ## datacenters_servers_patch
641
-
642
- > <Server> datacenters_servers_patch(datacenter_id, server_id, server, opts)
643
-
644
- Partially modify a Server
645
-
646
- You can use update attributes of a server
647
-
648
- ### Examples
649
-
650
- ```ruby
651
- require 'time'
652
- require 'ionoscloud'
653
- # setup authorization
654
- Ionoscloud.configure do |config|
655
- # Configure HTTP basic authorization: Basic Authentication
656
- config.username = 'YOUR USERNAME'
657
- config.password = 'YOUR PASSWORD'
658
-
659
- # Configure API key authorization: Token Authentication
660
- config.api_key['Authorization'] = 'YOUR API KEY'
661
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
662
- # config.api_key_prefix['Authorization'] = 'Bearer'
663
- end
664
-
665
- api_instance = Ionoscloud::ServersApi.new
666
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
667
- server_id = 'server_id_example' # String | The unique ID of the server
668
- server = Ionoscloud::ServerProperties.new({cores: 4, ram: 4096}) # ServerProperties | Modified properties of Server
669
- opts = {
670
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
671
- 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
672
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
673
- }
674
-
675
- begin
676
- # Partially modify a Server
677
- result = api_instance.datacenters_servers_patch(datacenter_id, server_id, server, opts)
678
- p result
679
- rescue Ionoscloud::ApiError => e
680
- puts "Error when calling ServersApi->datacenters_servers_patch: #{e}"
681
- end
682
- ```
683
-
684
- #### Using the datacenters_servers_patch_with_http_info variant
685
-
686
- This returns an Array which contains the response data, status code and headers.
687
-
688
- > <Array(<Server>, Integer, Hash)> datacenters_servers_patch_with_http_info(datacenter_id, server_id, server, opts)
689
-
690
- ```ruby
691
- begin
692
- # Partially modify a Server
693
- data, status_code, headers = api_instance.datacenters_servers_patch_with_http_info(datacenter_id, server_id, server, opts)
694
- p status_code # => 2xx
695
- p headers # => { ... }
696
- p data # => <Server>
697
- rescue Ionoscloud::ApiError => e
698
- puts "Error when calling ServersApi->datacenters_servers_patch_with_http_info: #{e}"
699
- end
700
- ```
701
-
702
- ### Parameters
703
-
704
- | Name | Type | Description | Notes |
705
- | ---- | ---- | ----------- | ----- |
706
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
707
- | **server_id** | **String** | The unique ID of the server | |
708
- | **server** | [**ServerProperties**](ServerProperties.md) | Modified properties of Server | |
709
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
710
- | **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] |
711
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
712
-
713
- ### Return type
714
-
715
- [**Server**](Server.md)
716
-
717
- ### Authorization
718
-
719
- Basic Authentication, Token Authentication
720
-
721
- ### HTTP request headers
722
-
723
- - **Content-Type**: application/json
724
- - **Accept**: application/json
725
-
726
-
727
- ## datacenters_servers_post
728
-
729
- > <Server> datacenters_servers_post(datacenter_id, server, opts)
730
-
731
- Create a Server
732
-
733
- Creates a server within an existing datacenter. You can configure the boot volume and connect the server to an existing LAN.
734
-
735
- ### Examples
736
-
737
- ```ruby
738
- require 'time'
739
- require 'ionoscloud'
740
- # setup authorization
741
- Ionoscloud.configure do |config|
742
- # Configure HTTP basic authorization: Basic Authentication
743
- config.username = 'YOUR USERNAME'
744
- config.password = 'YOUR PASSWORD'
745
-
746
- # Configure API key authorization: Token Authentication
747
- config.api_key['Authorization'] = 'YOUR API KEY'
748
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
749
- # config.api_key_prefix['Authorization'] = 'Bearer'
750
- end
751
-
752
- api_instance = Ionoscloud::ServersApi.new
753
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
754
- server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | Server to be created
755
- opts = {
756
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
757
- 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
758
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
759
- }
760
-
761
- begin
762
- # Create a Server
763
- result = api_instance.datacenters_servers_post(datacenter_id, server, opts)
764
- p result
765
- rescue Ionoscloud::ApiError => e
766
- puts "Error when calling ServersApi->datacenters_servers_post: #{e}"
767
- end
768
- ```
769
-
770
- #### Using the datacenters_servers_post_with_http_info variant
771
-
772
- This returns an Array which contains the response data, status code and headers.
773
-
774
- > <Array(<Server>, Integer, Hash)> datacenters_servers_post_with_http_info(datacenter_id, server, opts)
775
-
776
- ```ruby
777
- begin
778
- # Create a Server
779
- data, status_code, headers = api_instance.datacenters_servers_post_with_http_info(datacenter_id, server, opts)
780
- p status_code # => 2xx
781
- p headers # => { ... }
782
- p data # => <Server>
783
- rescue Ionoscloud::ApiError => e
784
- puts "Error when calling ServersApi->datacenters_servers_post_with_http_info: #{e}"
785
- end
786
- ```
787
-
788
- ### Parameters
789
-
790
- | Name | Type | Description | Notes |
791
- | ---- | ---- | ----------- | ----- |
792
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
793
- | **server** | [**Server**](Server.md) | Server to be created | |
794
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
795
- | **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] |
796
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
797
-
798
- ### Return type
799
-
800
- [**Server**](Server.md)
801
-
802
- ### Authorization
803
-
804
- Basic Authentication, Token Authentication
805
-
806
- ### HTTP request headers
807
-
808
- - **Content-Type**: application/json
809
- - **Accept**: application/json
810
-
811
-
812
- ## datacenters_servers_put
813
-
814
- > <Server> datacenters_servers_put(datacenter_id, server_id, server, opts)
815
-
816
- Modify a Server
817
-
818
- 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
819
-
820
- ### Examples
821
-
822
- ```ruby
823
- require 'time'
824
- require 'ionoscloud'
825
- # setup authorization
826
- Ionoscloud.configure do |config|
827
- # Configure HTTP basic authorization: Basic Authentication
828
- config.username = 'YOUR USERNAME'
829
- config.password = 'YOUR PASSWORD'
830
-
831
- # Configure API key authorization: Token Authentication
832
- config.api_key['Authorization'] = 'YOUR API KEY'
833
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
834
- # config.api_key_prefix['Authorization'] = 'Bearer'
835
- end
836
-
837
- api_instance = Ionoscloud::ServersApi.new
838
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
839
- server_id = 'server_id_example' # String | The unique ID of the server
840
- server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | Modified Server
841
- opts = {
842
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
843
- 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
844
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
845
- }
846
-
847
- begin
848
- # Modify a Server
849
- result = api_instance.datacenters_servers_put(datacenter_id, server_id, server, opts)
850
- p result
851
- rescue Ionoscloud::ApiError => e
852
- puts "Error when calling ServersApi->datacenters_servers_put: #{e}"
853
- end
854
- ```
855
-
856
- #### Using the datacenters_servers_put_with_http_info variant
857
-
858
- This returns an Array which contains the response data, status code and headers.
859
-
860
- > <Array(<Server>, Integer, Hash)> datacenters_servers_put_with_http_info(datacenter_id, server_id, server, opts)
861
-
862
- ```ruby
863
- begin
864
- # Modify a Server
865
- data, status_code, headers = api_instance.datacenters_servers_put_with_http_info(datacenter_id, server_id, server, opts)
866
- p status_code # => 2xx
867
- p headers # => { ... }
868
- p data # => <Server>
869
- rescue Ionoscloud::ApiError => e
870
- puts "Error when calling ServersApi->datacenters_servers_put_with_http_info: #{e}"
871
- end
872
- ```
873
-
874
- ### Parameters
875
-
876
- | Name | Type | Description | Notes |
877
- | ---- | ---- | ----------- | ----- |
878
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
879
- | **server_id** | **String** | The unique ID of the server | |
880
- | **server** | [**Server**](Server.md) | Modified Server | |
881
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
882
- | **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] |
883
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
884
-
885
- ### Return type
886
-
887
- [**Server**](Server.md)
888
-
889
- ### Authorization
890
-
891
- Basic Authentication, Token Authentication
892
-
893
- ### HTTP request headers
894
-
895
- - **Content-Type**: application/json
896
- - **Accept**: application/json
897
-
898
-
899
- ## datacenters_servers_reboot_post
900
-
901
- > Object datacenters_servers_reboot_post(datacenter_id, server_id, opts)
902
-
903
- Reboot a Server
904
-
905
- 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.
906
-
907
- ### Examples
908
-
909
- ```ruby
910
- require 'time'
911
- require 'ionoscloud'
912
- # setup authorization
913
- Ionoscloud.configure do |config|
914
- # Configure HTTP basic authorization: Basic Authentication
915
- config.username = 'YOUR USERNAME'
916
- config.password = 'YOUR PASSWORD'
917
-
918
- # Configure API key authorization: Token Authentication
919
- config.api_key['Authorization'] = 'YOUR API KEY'
920
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
921
- # config.api_key_prefix['Authorization'] = 'Bearer'
922
- end
923
-
924
- api_instance = Ionoscloud::ServersApi.new
925
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
926
- server_id = 'server_id_example' # String | The unique ID of the Server
927
- opts = {
928
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
929
- 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
930
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
931
- }
932
-
933
- begin
934
- # Reboot a Server
935
- result = api_instance.datacenters_servers_reboot_post(datacenter_id, server_id, opts)
936
- p result
937
- rescue Ionoscloud::ApiError => e
938
- puts "Error when calling ServersApi->datacenters_servers_reboot_post: #{e}"
939
- end
940
- ```
941
-
942
- #### Using the datacenters_servers_reboot_post_with_http_info variant
943
-
944
- This returns an Array which contains the response data, status code and headers.
945
-
946
- > <Array(Object, Integer, Hash)> datacenters_servers_reboot_post_with_http_info(datacenter_id, server_id, opts)
947
-
948
- ```ruby
949
- begin
950
- # Reboot a Server
951
- data, status_code, headers = api_instance.datacenters_servers_reboot_post_with_http_info(datacenter_id, server_id, opts)
952
- p status_code # => 2xx
953
- p headers # => { ... }
954
- p data # => Object
955
- rescue Ionoscloud::ApiError => e
956
- puts "Error when calling ServersApi->datacenters_servers_reboot_post_with_http_info: #{e}"
957
- end
958
- ```
959
-
960
- ### Parameters
961
-
962
- | Name | Type | Description | Notes |
963
- | ---- | ---- | ----------- | ----- |
964
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
965
- | **server_id** | **String** | The unique ID of the Server | |
966
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
967
- | **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] |
968
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
969
-
970
- ### Return type
971
-
972
- **Object**
973
-
974
- ### Authorization
975
-
976
- Basic Authentication, Token Authentication
977
-
978
- ### HTTP request headers
979
-
980
- - **Content-Type**: Not defined
981
- - **Accept**: application/json
982
-
983
-
984
- ## datacenters_servers_remote_console_get
985
-
986
- > <RemoteConsoleUrl> datacenters_servers_remote_console_get(datacenter_id, server_id, opts)
987
-
988
- Get the server remote console link
989
-
990
- Returns the link with the jwToken to access the server remote console
991
-
992
- ### Examples
993
-
994
- ```ruby
995
- require 'time'
996
- require 'ionoscloud'
997
- # setup authorization
998
- Ionoscloud.configure do |config|
999
- # Configure HTTP basic authorization: Basic Authentication
1000
- config.username = 'YOUR USERNAME'
1001
- config.password = 'YOUR PASSWORD'
1002
-
1003
- # Configure API key authorization: Token Authentication
1004
- config.api_key['Authorization'] = 'YOUR API KEY'
1005
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1006
- # config.api_key_prefix['Authorization'] = 'Bearer'
1007
- end
1008
-
1009
- api_instance = Ionoscloud::ServersApi.new
1010
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1011
- server_id = 'server_id_example' # String | The unique ID of the Server
1012
- opts = {
1013
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1014
- 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
1015
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1016
- }
1017
-
1018
- begin
1019
- # Get the server remote console link
1020
- result = api_instance.datacenters_servers_remote_console_get(datacenter_id, server_id, opts)
1021
- p result
1022
- rescue Ionoscloud::ApiError => e
1023
- puts "Error when calling ServersApi->datacenters_servers_remote_console_get: #{e}"
1024
- end
1025
- ```
1026
-
1027
- #### Using the datacenters_servers_remote_console_get_with_http_info variant
1028
-
1029
- This returns an Array which contains the response data, status code and headers.
1030
-
1031
- > <Array(<RemoteConsoleUrl>, Integer, Hash)> datacenters_servers_remote_console_get_with_http_info(datacenter_id, server_id, opts)
1032
-
1033
- ```ruby
1034
- begin
1035
- # Get the server remote console link
1036
- data, status_code, headers = api_instance.datacenters_servers_remote_console_get_with_http_info(datacenter_id, server_id, opts)
1037
- p status_code # => 2xx
1038
- p headers # => { ... }
1039
- p data # => <RemoteConsoleUrl>
1040
- rescue Ionoscloud::ApiError => e
1041
- puts "Error when calling ServersApi->datacenters_servers_remote_console_get_with_http_info: #{e}"
1042
- end
1043
- ```
1044
-
1045
- ### Parameters
1046
-
1047
- | Name | Type | Description | Notes |
1048
- | ---- | ---- | ----------- | ----- |
1049
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1050
- | **server_id** | **String** | The unique ID of the Server | |
1051
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1052
- | **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] |
1053
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1054
-
1055
- ### Return type
1056
-
1057
- [**RemoteConsoleUrl**](RemoteConsoleUrl.md)
1058
-
1059
- ### Authorization
1060
-
1061
- Basic Authentication, Token Authentication
1062
-
1063
- ### HTTP request headers
1064
-
1065
- - **Content-Type**: Not defined
1066
- - **Accept**: application/json
1067
-
1068
-
1069
- ## datacenters_servers_resume_post
1070
-
1071
- > Object datacenters_servers_resume_post(datacenter_id, server_id, opts)
1072
-
1073
- Resume a Cube Server
1074
-
1075
- This will resume a suspended server. The operation can only be applied to suspended Cube servers. No billing event will be generated.
1076
-
1077
- ### Examples
1078
-
1079
- ```ruby
1080
- require 'time'
1081
- require 'ionoscloud'
1082
- # setup authorization
1083
- Ionoscloud.configure do |config|
1084
- # Configure HTTP basic authorization: Basic Authentication
1085
- config.username = 'YOUR USERNAME'
1086
- config.password = 'YOUR PASSWORD'
1087
-
1088
- # Configure API key authorization: Token Authentication
1089
- config.api_key['Authorization'] = 'YOUR API KEY'
1090
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1091
- # config.api_key_prefix['Authorization'] = 'Bearer'
1092
- end
1093
-
1094
- api_instance = Ionoscloud::ServersApi.new
1095
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1096
- server_id = 'server_id_example' # String | The unique ID of the Server
1097
- opts = {
1098
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1099
- 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
1100
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1101
- }
1102
-
1103
- begin
1104
- # Resume a Cube Server
1105
- result = api_instance.datacenters_servers_resume_post(datacenter_id, server_id, opts)
1106
- p result
1107
- rescue Ionoscloud::ApiError => e
1108
- puts "Error when calling ServersApi->datacenters_servers_resume_post: #{e}"
1109
- end
1110
- ```
1111
-
1112
- #### Using the datacenters_servers_resume_post_with_http_info variant
1113
-
1114
- This returns an Array which contains the response data, status code and headers.
1115
-
1116
- > <Array(Object, Integer, Hash)> datacenters_servers_resume_post_with_http_info(datacenter_id, server_id, opts)
1117
-
1118
- ```ruby
1119
- begin
1120
- # Resume a Cube Server
1121
- data, status_code, headers = api_instance.datacenters_servers_resume_post_with_http_info(datacenter_id, server_id, opts)
1122
- p status_code # => 2xx
1123
- p headers # => { ... }
1124
- p data # => Object
1125
- rescue Ionoscloud::ApiError => e
1126
- puts "Error when calling ServersApi->datacenters_servers_resume_post_with_http_info: #{e}"
1127
- end
1128
- ```
1129
-
1130
- ### Parameters
1131
-
1132
- | Name | Type | Description | Notes |
1133
- | ---- | ---- | ----------- | ----- |
1134
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1135
- | **server_id** | **String** | The unique ID of the Server | |
1136
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1137
- | **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] |
1138
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1139
-
1140
- ### Return type
1141
-
1142
- **Object**
1143
-
1144
- ### Authorization
1145
-
1146
- Basic Authentication, Token Authentication
1147
-
1148
- ### HTTP request headers
1149
-
1150
- - **Content-Type**: Not defined
1151
- - **Accept**: application/json
1152
-
1153
-
1154
- ## datacenters_servers_start_post
1155
-
1156
- > Object datacenters_servers_start_post(datacenter_id, server_id, opts)
1157
-
1158
- Start a Server
1159
-
1160
- This will start a server. If the server's public IP was deallocated then a new IP will be assigned
1161
-
1162
- ### Examples
1163
-
1164
- ```ruby
1165
- require 'time'
1166
- require 'ionoscloud'
1167
- # setup authorization
1168
- Ionoscloud.configure do |config|
1169
- # Configure HTTP basic authorization: Basic Authentication
1170
- config.username = 'YOUR USERNAME'
1171
- config.password = 'YOUR PASSWORD'
1172
-
1173
- # Configure API key authorization: Token Authentication
1174
- config.api_key['Authorization'] = 'YOUR API KEY'
1175
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1176
- # config.api_key_prefix['Authorization'] = 'Bearer'
1177
- end
1178
-
1179
- api_instance = Ionoscloud::ServersApi.new
1180
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1181
- server_id = 'server_id_example' # String | The unique ID of the Server
1182
- opts = {
1183
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1184
- 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
1185
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1186
- }
1187
-
1188
- begin
1189
- # Start a Server
1190
- result = api_instance.datacenters_servers_start_post(datacenter_id, server_id, opts)
1191
- p result
1192
- rescue Ionoscloud::ApiError => e
1193
- puts "Error when calling ServersApi->datacenters_servers_start_post: #{e}"
1194
- end
1195
- ```
1196
-
1197
- #### Using the datacenters_servers_start_post_with_http_info variant
1198
-
1199
- This returns an Array which contains the response data, status code and headers.
1200
-
1201
- > <Array(Object, Integer, Hash)> datacenters_servers_start_post_with_http_info(datacenter_id, server_id, opts)
1202
-
1203
- ```ruby
1204
- begin
1205
- # Start a Server
1206
- data, status_code, headers = api_instance.datacenters_servers_start_post_with_http_info(datacenter_id, server_id, opts)
1207
- p status_code # => 2xx
1208
- p headers # => { ... }
1209
- p data # => Object
1210
- rescue Ionoscloud::ApiError => e
1211
- puts "Error when calling ServersApi->datacenters_servers_start_post_with_http_info: #{e}"
1212
- end
1213
- ```
1214
-
1215
- ### Parameters
1216
-
1217
- | Name | Type | Description | Notes |
1218
- | ---- | ---- | ----------- | ----- |
1219
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1220
- | **server_id** | **String** | The unique ID of the Server | |
1221
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1222
- | **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] |
1223
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1224
-
1225
- ### Return type
1226
-
1227
- **Object**
1228
-
1229
- ### Authorization
1230
-
1231
- Basic Authentication, Token Authentication
1232
-
1233
- ### HTTP request headers
1234
-
1235
- - **Content-Type**: Not defined
1236
- - **Accept**: application/json
1237
-
1238
-
1239
- ## datacenters_servers_stop_post
1240
-
1241
- > Object datacenters_servers_stop_post(datacenter_id, server_id, opts)
1242
-
1243
- Stop a Server
1244
-
1245
- 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.
1246
-
1247
- ### Examples
1248
-
1249
- ```ruby
1250
- require 'time'
1251
- require 'ionoscloud'
1252
- # setup authorization
1253
- Ionoscloud.configure do |config|
1254
- # Configure HTTP basic authorization: Basic Authentication
1255
- config.username = 'YOUR USERNAME'
1256
- config.password = 'YOUR PASSWORD'
1257
-
1258
- # Configure API key authorization: Token Authentication
1259
- config.api_key['Authorization'] = 'YOUR API KEY'
1260
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1261
- # config.api_key_prefix['Authorization'] = 'Bearer'
1262
- end
1263
-
1264
- api_instance = Ionoscloud::ServersApi.new
1265
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1266
- server_id = 'server_id_example' # String | The unique ID of the Server
1267
- opts = {
1268
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1269
- 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
1270
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1271
- }
1272
-
1273
- begin
1274
- # Stop a Server
1275
- result = api_instance.datacenters_servers_stop_post(datacenter_id, server_id, opts)
1276
- p result
1277
- rescue Ionoscloud::ApiError => e
1278
- puts "Error when calling ServersApi->datacenters_servers_stop_post: #{e}"
1279
- end
1280
- ```
1281
-
1282
- #### Using the datacenters_servers_stop_post_with_http_info variant
1283
-
1284
- This returns an Array which contains the response data, status code and headers.
1285
-
1286
- > <Array(Object, Integer, Hash)> datacenters_servers_stop_post_with_http_info(datacenter_id, server_id, opts)
1287
-
1288
- ```ruby
1289
- begin
1290
- # Stop a Server
1291
- data, status_code, headers = api_instance.datacenters_servers_stop_post_with_http_info(datacenter_id, server_id, opts)
1292
- p status_code # => 2xx
1293
- p headers # => { ... }
1294
- p data # => Object
1295
- rescue Ionoscloud::ApiError => e
1296
- puts "Error when calling ServersApi->datacenters_servers_stop_post_with_http_info: #{e}"
1297
- end
1298
- ```
1299
-
1300
- ### Parameters
1301
-
1302
- | Name | Type | Description | Notes |
1303
- | ---- | ---- | ----------- | ----- |
1304
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1305
- | **server_id** | **String** | The unique ID of the Server | |
1306
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1307
- | **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] |
1308
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1309
-
1310
- ### Return type
1311
-
1312
- **Object**
1313
-
1314
- ### Authorization
1315
-
1316
- Basic Authentication, Token Authentication
1317
-
1318
- ### HTTP request headers
1319
-
1320
- - **Content-Type**: Not defined
1321
- - **Accept**: application/json
1322
-
1323
-
1324
- ## datacenters_servers_suspend_post
1325
-
1326
- > Object datacenters_servers_suspend_post(datacenter_id, server_id, opts)
1327
-
1328
- Suspend a Cube Server
1329
-
1330
- This will suspend a server. The operation can only be applied to Cube servers. Note: The virtual machine will not be deleted, and the consumed resources will continue to be billed.
1331
-
1332
- ### Examples
1333
-
1334
- ```ruby
1335
- require 'time'
1336
- require 'ionoscloud'
1337
- # setup authorization
1338
- Ionoscloud.configure do |config|
1339
- # Configure HTTP basic authorization: Basic Authentication
1340
- config.username = 'YOUR USERNAME'
1341
- config.password = 'YOUR PASSWORD'
1342
-
1343
- # Configure API key authorization: Token Authentication
1344
- config.api_key['Authorization'] = 'YOUR API KEY'
1345
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1346
- # config.api_key_prefix['Authorization'] = 'Bearer'
1347
- end
1348
-
1349
- api_instance = Ionoscloud::ServersApi.new
1350
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1351
- server_id = 'server_id_example' # String | The unique ID of the Server
1352
- opts = {
1353
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1354
- 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
1355
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1356
- }
1357
-
1358
- begin
1359
- # Suspend a Cube Server
1360
- result = api_instance.datacenters_servers_suspend_post(datacenter_id, server_id, opts)
1361
- p result
1362
- rescue Ionoscloud::ApiError => e
1363
- puts "Error when calling ServersApi->datacenters_servers_suspend_post: #{e}"
1364
- end
1365
- ```
1366
-
1367
- #### Using the datacenters_servers_suspend_post_with_http_info variant
1368
-
1369
- This returns an Array which contains the response data, status code and headers.
1370
-
1371
- > <Array(Object, Integer, Hash)> datacenters_servers_suspend_post_with_http_info(datacenter_id, server_id, opts)
1372
-
1373
- ```ruby
1374
- begin
1375
- # Suspend a Cube Server
1376
- data, status_code, headers = api_instance.datacenters_servers_suspend_post_with_http_info(datacenter_id, server_id, opts)
1377
- p status_code # => 2xx
1378
- p headers # => { ... }
1379
- p data # => Object
1380
- rescue Ionoscloud::ApiError => e
1381
- puts "Error when calling ServersApi->datacenters_servers_suspend_post_with_http_info: #{e}"
1382
- end
1383
- ```
1384
-
1385
- ### Parameters
1386
-
1387
- | Name | Type | Description | Notes |
1388
- | ---- | ---- | ----------- | ----- |
1389
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1390
- | **server_id** | **String** | The unique ID of the Server | |
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
- **Object**
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_token_get
1410
-
1411
- > <Token> datacenters_servers_token_get(datacenter_id, server_id, opts)
1412
-
1413
- Get the server's jwToken
1414
-
1415
- Returns the server json web token to be used for login operations (ex: accessing the server console)
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
-
1428
- # Configure API key authorization: Token Authentication
1429
- config.api_key['Authorization'] = 'YOUR API KEY'
1430
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1431
- # config.api_key_prefix['Authorization'] = 'Bearer'
1432
- end
1433
-
1434
- api_instance = Ionoscloud::ServersApi.new
1435
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1436
- server_id = 'server_id_example' # String | The unique ID of the Server
1437
- opts = {
1438
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1439
- 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
1440
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1441
- }
1442
-
1443
- begin
1444
- # Get the server's jwToken
1445
- result = api_instance.datacenters_servers_token_get(datacenter_id, server_id, opts)
1446
- p result
1447
- rescue Ionoscloud::ApiError => e
1448
- puts "Error when calling ServersApi->datacenters_servers_token_get: #{e}"
1449
- end
1450
- ```
1451
-
1452
- #### Using the datacenters_servers_token_get_with_http_info variant
1453
-
1454
- This returns an Array which contains the response data, status code and headers.
1455
-
1456
- > <Array(<Token>, Integer, Hash)> datacenters_servers_token_get_with_http_info(datacenter_id, server_id, opts)
1457
-
1458
- ```ruby
1459
- begin
1460
- # Get the server's jwToken
1461
- data, status_code, headers = api_instance.datacenters_servers_token_get_with_http_info(datacenter_id, server_id, opts)
1462
- p status_code # => 2xx
1463
- p headers # => { ... }
1464
- p data # => <Token>
1465
- rescue Ionoscloud::ApiError => e
1466
- puts "Error when calling ServersApi->datacenters_servers_token_get_with_http_info: #{e}"
1467
- end
1468
- ```
1469
-
1470
- ### Parameters
1471
-
1472
- | Name | Type | Description | Notes |
1473
- | ---- | ---- | ----------- | ----- |
1474
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1475
- | **server_id** | **String** | The unique ID of the Server | |
1476
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1477
- | **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] |
1478
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1479
-
1480
- ### Return type
1481
-
1482
- [**Token**](Token.md)
1483
-
1484
- ### Authorization
1485
-
1486
- Basic Authentication, Token Authentication
1487
-
1488
- ### HTTP request headers
1489
-
1490
- - **Content-Type**: Not defined
1491
- - **Accept**: application/json
1492
-
1493
-
1494
- ## datacenters_servers_upgrade_post
1495
-
1496
- > Object datacenters_servers_upgrade_post(datacenter_id, server_id, opts)
1497
-
1498
- Upgrade a Server
1499
-
1500
- 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'
1501
-
1502
- ### Examples
1503
-
1504
- ```ruby
1505
- require 'time'
1506
- require 'ionoscloud'
1507
- # setup authorization
1508
- Ionoscloud.configure do |config|
1509
- # Configure HTTP basic authorization: Basic Authentication
1510
- config.username = 'YOUR USERNAME'
1511
- config.password = 'YOUR PASSWORD'
1512
-
1513
- # Configure API key authorization: Token Authentication
1514
- config.api_key['Authorization'] = 'YOUR API KEY'
1515
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1516
- # config.api_key_prefix['Authorization'] = 'Bearer'
1517
- end
1518
-
1519
- api_instance = Ionoscloud::ServersApi.new
1520
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1521
- server_id = 'server_id_example' # String | The unique ID of the Server
1522
- opts = {
1523
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1524
- 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
1525
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1526
- }
1527
-
1528
- begin
1529
- # Upgrade a Server
1530
- result = api_instance.datacenters_servers_upgrade_post(datacenter_id, server_id, opts)
1531
- p result
1532
- rescue Ionoscloud::ApiError => e
1533
- puts "Error when calling ServersApi->datacenters_servers_upgrade_post: #{e}"
1534
- end
1535
- ```
1536
-
1537
- #### Using the datacenters_servers_upgrade_post_with_http_info variant
1538
-
1539
- This returns an Array which contains the response data, status code and headers.
1540
-
1541
- > <Array(Object, Integer, Hash)> datacenters_servers_upgrade_post_with_http_info(datacenter_id, server_id, opts)
1542
-
1543
- ```ruby
1544
- begin
1545
- # Upgrade a Server
1546
- data, status_code, headers = api_instance.datacenters_servers_upgrade_post_with_http_info(datacenter_id, server_id, opts)
1547
- p status_code # => 2xx
1548
- p headers # => { ... }
1549
- p data # => Object
1550
- rescue Ionoscloud::ApiError => e
1551
- puts "Error when calling ServersApi->datacenters_servers_upgrade_post_with_http_info: #{e}"
1552
- end
1553
- ```
1554
-
1555
- ### Parameters
1556
-
1557
- | Name | Type | Description | Notes |
1558
- | ---- | ---- | ----------- | ----- |
1559
- | **datacenter_id** | **String** | The unique ID of the datacenter | |
1560
- | **server_id** | **String** | The unique ID of the Server | |
1561
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1562
- | **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] |
1563
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1564
-
1565
- ### Return type
1566
-
1567
- **Object**
1568
-
1569
- ### Authorization
1570
-
1571
- Basic Authentication, Token Authentication
1572
-
1573
- ### HTTP request headers
1574
-
1575
- - **Content-Type**: Not defined
1576
- - **Accept**: application/json
1577
-
1578
-
1579
- ## datacenters_servers_volumes_delete
1580
-
1581
- > Object datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, opts)
1582
-
1583
- Detach a volume
1584
-
1585
- 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
1586
-
1587
- ### Examples
1588
-
1589
- ```ruby
1590
- require 'time'
1591
- require 'ionoscloud'
1592
- # setup authorization
1593
- Ionoscloud.configure do |config|
1594
- # Configure HTTP basic authorization: Basic Authentication
1595
- config.username = 'YOUR USERNAME'
1596
- config.password = 'YOUR PASSWORD'
1597
-
1598
- # Configure API key authorization: Token Authentication
1599
- config.api_key['Authorization'] = 'YOUR API KEY'
1600
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1601
- # config.api_key_prefix['Authorization'] = 'Bearer'
1602
- end
1603
-
1604
- api_instance = Ionoscloud::ServersApi.new
1605
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1606
- server_id = 'server_id_example' # String | The unique ID of the Server
1607
- volume_id = 'volume_id_example' # String | The unique ID of the Volume
1608
- opts = {
1609
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1610
- 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
1611
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1612
- }
1613
-
1614
- begin
1615
- # Detach a volume
1616
- result = api_instance.datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, opts)
1617
- p result
1618
- rescue Ionoscloud::ApiError => e
1619
- puts "Error when calling ServersApi->datacenters_servers_volumes_delete: #{e}"
1620
- end
1621
- ```
1622
-
1623
- #### Using the datacenters_servers_volumes_delete_with_http_info variant
1624
-
1625
- This returns an Array which contains the response data, status code and headers.
1626
-
1627
- > <Array(Object, Integer, Hash)> datacenters_servers_volumes_delete_with_http_info(datacenter_id, server_id, volume_id, opts)
1628
-
1629
- ```ruby
1630
- begin
1631
- # Detach a volume
1632
- data, status_code, headers = api_instance.datacenters_servers_volumes_delete_with_http_info(datacenter_id, server_id, volume_id, opts)
1633
- p status_code # => 2xx
1634
- p headers # => { ... }
1635
- p data # => Object
1636
- rescue Ionoscloud::ApiError => e
1637
- puts "Error when calling ServersApi->datacenters_servers_volumes_delete_with_http_info: #{e}"
1638
- end
1639
- ```
1640
-
1641
- ### Parameters
1642
-
1643
- | Name | Type | Description | Notes |
1644
- | ---- | ---- | ----------- | ----- |
1645
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1646
- | **server_id** | **String** | The unique ID of the Server | |
1647
- | **volume_id** | **String** | The unique ID of the Volume | |
1648
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1649
- | **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] |
1650
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1651
-
1652
- ### Return type
1653
-
1654
- **Object**
1655
-
1656
- ### Authorization
1657
-
1658
- Basic Authentication, Token Authentication
1659
-
1660
- ### HTTP request headers
1661
-
1662
- - **Content-Type**: Not defined
1663
- - **Accept**: application/json
1664
-
1665
-
1666
- ## datacenters_servers_volumes_find_by_id
1667
-
1668
- > <Volume> datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, opts)
1669
-
1670
- Retrieve an attached volume
1671
-
1672
- This will retrieve the properties of an attached volume.
1673
-
1674
- ### Examples
1675
-
1676
- ```ruby
1677
- require 'time'
1678
- require 'ionoscloud'
1679
- # setup authorization
1680
- Ionoscloud.configure do |config|
1681
- # Configure HTTP basic authorization: Basic Authentication
1682
- config.username = 'YOUR USERNAME'
1683
- config.password = 'YOUR PASSWORD'
1684
-
1685
- # Configure API key authorization: Token Authentication
1686
- config.api_key['Authorization'] = 'YOUR API KEY'
1687
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1688
- # config.api_key_prefix['Authorization'] = 'Bearer'
1689
- end
1690
-
1691
- api_instance = Ionoscloud::ServersApi.new
1692
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1693
- server_id = 'server_id_example' # String | The unique ID of the Server
1694
- volume_id = 'volume_id_example' # String | The unique ID of the Volume
1695
- opts = {
1696
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1697
- 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
1698
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1699
- }
1700
-
1701
- begin
1702
- # Retrieve an attached volume
1703
- result = api_instance.datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, opts)
1704
- p result
1705
- rescue Ionoscloud::ApiError => e
1706
- puts "Error when calling ServersApi->datacenters_servers_volumes_find_by_id: #{e}"
1707
- end
1708
- ```
1709
-
1710
- #### Using the datacenters_servers_volumes_find_by_id_with_http_info variant
1711
-
1712
- This returns an Array which contains the response data, status code and headers.
1713
-
1714
- > <Array(<Volume>, Integer, Hash)> datacenters_servers_volumes_find_by_id_with_http_info(datacenter_id, server_id, volume_id, opts)
1715
-
1716
- ```ruby
1717
- begin
1718
- # Retrieve an attached volume
1719
- data, status_code, headers = api_instance.datacenters_servers_volumes_find_by_id_with_http_info(datacenter_id, server_id, volume_id, opts)
1720
- p status_code # => 2xx
1721
- p headers # => { ... }
1722
- p data # => <Volume>
1723
- rescue Ionoscloud::ApiError => e
1724
- puts "Error when calling ServersApi->datacenters_servers_volumes_find_by_id_with_http_info: #{e}"
1725
- end
1726
- ```
1727
-
1728
- ### Parameters
1729
-
1730
- | Name | Type | Description | Notes |
1731
- | ---- | ---- | ----------- | ----- |
1732
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1733
- | **server_id** | **String** | The unique ID of the Server | |
1734
- | **volume_id** | **String** | The unique ID of the Volume | |
1735
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1736
- | **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] |
1737
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1738
-
1739
- ### Return type
1740
-
1741
- [**Volume**](Volume.md)
1742
-
1743
- ### Authorization
1744
-
1745
- Basic Authentication, Token Authentication
1746
-
1747
- ### HTTP request headers
1748
-
1749
- - **Content-Type**: Not defined
1750
- - **Accept**: application/json
1751
-
1752
-
1753
- ## datacenters_servers_volumes_get
1754
-
1755
- > <AttachedVolumes> datacenters_servers_volumes_get(datacenter_id, server_id, opts)
1756
-
1757
- List Attached Volumes
1758
-
1759
- You can retrieve a list of volumes attached to the server
1760
-
1761
- ### Examples
1762
-
1763
- ```ruby
1764
- require 'time'
1765
- require 'ionoscloud'
1766
- # setup authorization
1767
- Ionoscloud.configure do |config|
1768
- # Configure HTTP basic authorization: Basic Authentication
1769
- config.username = 'YOUR USERNAME'
1770
- config.password = 'YOUR PASSWORD'
1771
- end
1772
-
1773
- api_instance = Ionoscloud::ServersApi.new
1774
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1775
- server_id = 'server_id_example' # String | The unique ID of the Server
1776
- opts = {
1777
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1778
- 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
1779
- x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1780
- offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with limit for pagination)
1781
- limit: 56 # Integer | the maximum number of elements to return (use together with offset for pagination)
1782
- }
1783
-
1784
- begin
1785
- # List Attached Volumes
1786
- result = api_instance.datacenters_servers_volumes_get(datacenter_id, server_id, opts)
1787
- p result
1788
- rescue Ionoscloud::ApiError => e
1789
- puts "Error when calling ServersApi->datacenters_servers_volumes_get: #{e}"
1790
- end
1791
- ```
1792
-
1793
- #### Using the datacenters_servers_volumes_get_with_http_info variant
1794
-
1795
- This returns an Array which contains the response data, status code and headers.
1796
-
1797
- > <Array(<AttachedVolumes>, Integer, Hash)> datacenters_servers_volumes_get_with_http_info(datacenter_id, server_id, opts)
1798
-
1799
- ```ruby
1800
- begin
1801
- # List Attached Volumes
1802
- data, status_code, headers = api_instance.datacenters_servers_volumes_get_with_http_info(datacenter_id, server_id, opts)
1803
- p status_code # => 2xx
1804
- p headers # => { ... }
1805
- p data # => <AttachedVolumes>
1806
- rescue Ionoscloud::ApiError => e
1807
- puts "Error when calling ServersApi->datacenters_servers_volumes_get_with_http_info: #{e}"
1808
- end
1809
- ```
1810
-
1811
- ### Parameters
1812
-
1813
- | Name | Type | Description | Notes |
1814
- | ---- | ---- | ----------- | ----- |
1815
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1816
- | **server_id** | **String** | The unique ID of the Server | |
1817
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1818
- | **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] |
1819
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1820
- | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with limit for pagination) | [optional][default to 0] |
1821
- | **limit** | **Integer** | the maximum number of elements to return (use together with offset for pagination) | [optional][default to 1000] |
1822
-
1823
- ### Return type
1824
-
1825
- [**AttachedVolumes**](AttachedVolumes.md)
1826
-
1827
- ### Authorization
1828
-
1829
- Basic Authentication
1830
-
1831
- ### HTTP request headers
1832
-
1833
- - **Content-Type**: Not defined
1834
- - **Accept**: application/json
1835
-
1836
-
1837
- ## datacenters_servers_volumes_post
1838
-
1839
- > <Volume> datacenters_servers_volumes_post(datacenter_id, server_id, volume, opts)
1840
-
1841
- Attach a volume
1842
-
1843
- 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.
1844
-
1845
- ### Examples
1846
-
1847
- ```ruby
1848
- require 'time'
1849
- require 'ionoscloud'
1850
- # setup authorization
1851
- Ionoscloud.configure do |config|
1852
- # Configure HTTP basic authorization: Basic Authentication
1853
- config.username = 'YOUR USERNAME'
1854
- config.password = 'YOUR PASSWORD'
1855
- end
1856
-
1857
- api_instance = Ionoscloud::ServersApi.new
1858
- datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1859
- server_id = 'server_id_example' # String | The unique ID of the Server
1860
- volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | Volume to be attached (created and attached)
1861
- opts = {
1862
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1863
- 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
1864
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1865
- }
1866
-
1867
- begin
1868
- # Attach a volume
1869
- result = api_instance.datacenters_servers_volumes_post(datacenter_id, server_id, volume, opts)
1870
- p result
1871
- rescue Ionoscloud::ApiError => e
1872
- puts "Error when calling ServersApi->datacenters_servers_volumes_post: #{e}"
1873
- end
1874
- ```
1875
-
1876
- #### Using the datacenters_servers_volumes_post_with_http_info variant
1877
-
1878
- This returns an Array which contains the response data, status code and headers.
1879
-
1880
- > <Array(<Volume>, Integer, Hash)> datacenters_servers_volumes_post_with_http_info(datacenter_id, server_id, volume, opts)
1881
-
1882
- ```ruby
1883
- begin
1884
- # Attach a volume
1885
- data, status_code, headers = api_instance.datacenters_servers_volumes_post_with_http_info(datacenter_id, server_id, volume, opts)
1886
- p status_code # => 2xx
1887
- p headers # => { ... }
1888
- p data # => <Volume>
1889
- rescue Ionoscloud::ApiError => e
1890
- puts "Error when calling ServersApi->datacenters_servers_volumes_post_with_http_info: #{e}"
1891
- end
1892
- ```
1893
-
1894
- ### Parameters
1895
-
1896
- | Name | Type | Description | Notes |
1897
- | ---- | ---- | ----------- | ----- |
1898
- | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1899
- | **server_id** | **String** | The unique ID of the Server | |
1900
- | **volume** | [**Volume**](Volume.md) | Volume to be attached (created and attached) | |
1901
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1902
- | **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] |
1903
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1904
-
1905
- ### Return type
1906
-
1907
- [**Volume**](Volume.md)
1908
-
1909
- ### Authorization
1910
-
1911
- Basic Authentication
1912
-
1913
- ### HTTP request headers
1914
-
1915
- - **Content-Type**: application/json
1916
- - **Accept**: application/json
1917
-