ionoscloud 5.1.1 → 6.0.0.beta.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (536) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -19
  3. data/docs/CHANGELOG.md +1 -0
  4. data/docs/README.md +4 -4
  5. data/docs/api/BackupUnitsApi.md +594 -0
  6. data/docs/api/ContractResourcesApi.md +89 -0
  7. data/docs/api/DataCentersApi.md +516 -0
  8. data/docs/api/DefaultApi.md +8 -19
  9. data/docs/api/FirewallRulesApi.md +552 -0
  10. data/docs/api/FlowLogsApi.md +540 -0
  11. data/docs/api/IPBlocksApi.md +50 -51
  12. data/docs/api/ImagesApi.md +428 -0
  13. data/docs/api/KubernetesApi.md +131 -211
  14. data/docs/api/LabelsApi.md +2338 -0
  15. data/docs/api/LansApi.md +794 -0
  16. data/docs/api/LoadBalancersApi.md +877 -0
  17. data/docs/api/LocationsApi.md +259 -0
  18. data/docs/api/NATGatewaysApi.md +1574 -0
  19. data/docs/api/NetworkInterfacesApi.md +540 -0
  20. data/docs/api/NetworkLoadBalancersApi.md +1586 -0
  21. data/docs/api/PrivateCrossConnectsApi.md +426 -0
  22. data/docs/api/{RequestApi.md → RequestsApi.md} +36 -36
  23. data/docs/api/ServersApi.md +1908 -0
  24. data/docs/api/SnapshotsApi.md +428 -0
  25. data/docs/api/TemplatesApi.md +165 -0
  26. data/docs/api/UserManagementApi.md +173 -687
  27. data/docs/api/UserS3KeysApi.md +516 -0
  28. data/docs/api/VolumesApi.md +709 -0
  29. data/docs/models/AttachedVolumes.md +1 -1
  30. data/docs/models/Cdroms.md +1 -1
  31. data/docs/models/Contracts.md +24 -0
  32. data/docs/models/CpuArchitectureProperties.md +24 -0
  33. data/docs/models/DataCenterEntities.md +5 -1
  34. data/docs/models/DatacenterProperties.md +3 -1
  35. data/docs/models/FirewallruleProperties.md +3 -1
  36. data/docs/models/FlowLog.md +26 -0
  37. data/docs/models/FlowLogProperties.md +24 -0
  38. data/docs/models/FlowLogPut.md +24 -0
  39. data/docs/models/FlowLogs.md +30 -0
  40. data/docs/models/Group.md +1 -1
  41. data/docs/models/GroupMembers.md +1 -1
  42. data/docs/models/GroupProperties.md +7 -1
  43. data/docs/models/GroupShare.md +1 -1
  44. data/docs/models/GroupShares.md +1 -1
  45. data/docs/models/GroupUsers.md +1 -1
  46. data/docs/models/Groups.md +1 -1
  47. data/docs/models/KubernetesAutoScaling.md +2 -2
  48. data/docs/models/KubernetesClusterProperties.md +1 -1
  49. data/docs/models/KubernetesClusterPropertiesForPost.md +1 -1
  50. data/docs/models/KubernetesClusterPropertiesForPut.md +1 -1
  51. data/docs/models/KubernetesClusters.md +1 -1
  52. data/docs/models/KubernetesMaintenanceWindow.md +2 -2
  53. data/docs/models/KubernetesNodePoolLan.md +5 -1
  54. data/docs/models/KubernetesNodePoolLanRoutes.md +20 -0
  55. data/docs/models/KubernetesNodePools.md +1 -1
  56. data/docs/models/Lans.md +1 -1
  57. data/docs/models/LocationProperties.md +3 -1
  58. data/docs/models/NatGateway.md +28 -0
  59. data/docs/models/NatGatewayEntities.md +20 -0
  60. data/docs/models/NatGatewayLanProperties.md +20 -0
  61. data/docs/models/NatGatewayProperties.md +22 -0
  62. data/docs/models/NatGatewayPut.md +24 -0
  63. data/docs/models/NatGatewayRule.md +26 -0
  64. data/docs/models/NatGatewayRuleProperties.md +30 -0
  65. data/docs/models/NatGatewayRuleProtocol.md +15 -0
  66. data/docs/models/NatGatewayRulePut.md +24 -0
  67. data/docs/models/NatGatewayRuleType.md +15 -0
  68. data/docs/models/NatGatewayRules.md +24 -0
  69. data/docs/models/NatGateways.md +30 -0
  70. data/docs/models/NetworkLoadBalancer.md +28 -0
  71. data/docs/models/NetworkLoadBalancerEntities.md +20 -0
  72. data/docs/models/NetworkLoadBalancerForwardingRule.md +26 -0
  73. data/docs/models/NetworkLoadBalancerForwardingRuleHealthCheck.md +24 -0
  74. data/docs/models/NetworkLoadBalancerForwardingRuleProperties.md +30 -0
  75. data/docs/models/NetworkLoadBalancerForwardingRulePut.md +24 -0
  76. data/docs/models/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
  77. data/docs/models/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
  78. data/docs/models/NetworkLoadBalancerForwardingRules.md +30 -0
  79. data/docs/models/NetworkLoadBalancerProperties.md +26 -0
  80. data/docs/models/NetworkLoadBalancerPut.md +24 -0
  81. data/docs/models/NetworkLoadBalancers.md +30 -0
  82. data/docs/models/NicEntities.md +2 -0
  83. data/docs/models/NicProperties.md +6 -2
  84. data/docs/models/NicPut.md +24 -0
  85. data/docs/models/Nics.md +1 -1
  86. data/docs/models/PrivateCrossConnectProperties.md +1 -1
  87. data/docs/models/RemoteConsoleUrl.md +18 -0
  88. data/docs/models/Resource.md +1 -1
  89. data/docs/models/ResourceGroups.md +1 -1
  90. data/docs/models/ResourceLimits.md +11 -1
  91. data/docs/models/ResourceProperties.md +1 -1
  92. data/docs/models/Resources.md +1 -1
  93. data/docs/models/ResourcesUsers.md +1 -1
  94. data/docs/models/S3Bucket.md +1 -1
  95. data/docs/models/S3Key.md +1 -1
  96. data/docs/models/S3Keys.md +1 -1
  97. data/docs/models/ServerProperties.md +6 -2
  98. data/docs/models/TargetPortRange.md +20 -0
  99. data/docs/models/Template.md +26 -0
  100. data/docs/models/TemplateProperties.md +24 -0
  101. data/docs/models/Templates.md +24 -0
  102. data/docs/models/Token.md +18 -0
  103. data/docs/models/VolumeProperties.md +5 -3
  104. data/docs/summary.md +386 -159
  105. data/ionoscloud.gemspec +3 -3
  106. data/lib/ionoscloud/api/_api.rb +9 -9
  107. data/lib/ionoscloud/api/{backup_unit_api.rb → backup_units_api.rb} +101 -101
  108. data/lib/ionoscloud/api/contract_resources_api.rb +96 -0
  109. data/lib/ionoscloud/api/data_centers_api.rb +532 -0
  110. data/lib/ionoscloud/api/firewall_rules_api.rb +640 -0
  111. data/lib/ionoscloud/api/flow_logs_api.rb +622 -0
  112. data/lib/ionoscloud/api/{image_api.rb → images_api.rb} +71 -71
  113. data/lib/ionoscloud/api/ip_blocks_api.rb +55 -55
  114. data/lib/ionoscloud/api/kubernetes_api.rb +131 -194
  115. data/lib/ionoscloud/api/{label_api.rb → labels_api.rb} +416 -470
  116. data/lib/ionoscloud/api/{lan_api.rb → lans_api.rb} +178 -178
  117. data/lib/ionoscloud/api/{load_balancer_api.rb → load_balancers_api.rb} +198 -216
  118. data/lib/ionoscloud/api/{location_api.rb → locations_api.rb} +49 -49
  119. data/lib/ionoscloud/api/nat_gateways_api.rb +1672 -0
  120. data/lib/ionoscloud/api/network_interfaces_api.rb +604 -0
  121. data/lib/ionoscloud/api/network_load_balancers_api.rb +1690 -0
  122. data/lib/ionoscloud/api/{private_cross_connect_api.rb → private_cross_connects_api.rb} +76 -76
  123. data/lib/ionoscloud/api/{request_api.rb → requests_api.rb} +45 -45
  124. data/lib/ionoscloud/api/servers_api.rb +2023 -0
  125. data/lib/ionoscloud/api/{snapshot_api.rb → snapshots_api.rb} +77 -77
  126. data/lib/ionoscloud/api/templates_api.rb +164 -0
  127. data/lib/ionoscloud/api/user_management_api.rb +172 -667
  128. data/lib/ionoscloud/api/user_s3_keys_api.rb +517 -0
  129. data/lib/ionoscloud/api/{volume_api.rb → volumes_api.rb} +145 -145
  130. data/lib/ionoscloud/api_client.rb +5 -5
  131. data/lib/ionoscloud/api_error.rb +2 -2
  132. data/lib/ionoscloud/configuration.rb +4 -4
  133. data/lib/ionoscloud/models/attached_volumes.rb +2 -2
  134. data/lib/ionoscloud/models/backup_unit.rb +2 -2
  135. data/lib/ionoscloud/models/backup_unit_properties.rb +2 -2
  136. data/lib/ionoscloud/models/backup_unit_sso.rb +2 -2
  137. data/lib/ionoscloud/models/backup_units.rb +2 -2
  138. data/lib/ionoscloud/models/balanced_nics.rb +2 -2
  139. data/lib/ionoscloud/models/cdroms.rb +2 -2
  140. data/lib/ionoscloud/models/connectable_datacenter.rb +2 -2
  141. data/lib/ionoscloud/models/contract.rb +2 -2
  142. data/lib/ionoscloud/models/contract_properties.rb +2 -2
  143. data/lib/ionoscloud/models/contracts.rb +251 -0
  144. data/lib/ionoscloud/models/cpu_architecture_properties.rb +249 -0
  145. data/lib/ionoscloud/models/data_center_entities.rb +24 -6
  146. data/lib/ionoscloud/models/datacenter.rb +2 -2
  147. data/lib/ionoscloud/models/datacenter_element_metadata.rb +4 -4
  148. data/lib/ionoscloud/models/datacenter_properties.rb +18 -6
  149. data/lib/ionoscloud/models/datacenters.rb +2 -2
  150. data/lib/ionoscloud/models/error.rb +2 -2
  151. data/lib/ionoscloud/models/error_message.rb +2 -2
  152. data/lib/ionoscloud/models/firewall_rule.rb +2 -2
  153. data/lib/ionoscloud/models/firewall_rules.rb +2 -2
  154. data/lib/ionoscloud/models/firewallrule_properties.rb +28 -6
  155. data/lib/ionoscloud/models/flow_log.rb +262 -0
  156. data/lib/ionoscloud/models/flow_log_properties.rb +315 -0
  157. data/lib/ionoscloud/models/{kubernetes_config.rb → flow_log_put.rb} +9 -43
  158. data/lib/ionoscloud/models/flow_logs.rb +280 -0
  159. data/lib/ionoscloud/models/group.rb +2 -2
  160. data/lib/ionoscloud/models/group_entities.rb +2 -2
  161. data/lib/ionoscloud/models/group_members.rb +2 -2
  162. data/lib/ionoscloud/models/group_properties.rb +36 -6
  163. data/lib/ionoscloud/models/group_share.rb +2 -2
  164. data/lib/ionoscloud/models/group_share_properties.rb +2 -2
  165. data/lib/ionoscloud/models/group_shares.rb +2 -2
  166. data/lib/ionoscloud/models/group_users.rb +2 -2
  167. data/lib/ionoscloud/models/groups.rb +2 -2
  168. data/lib/ionoscloud/models/image.rb +2 -2
  169. data/lib/ionoscloud/models/image_properties.rb +2 -2
  170. data/lib/ionoscloud/models/images.rb +2 -2
  171. data/lib/ionoscloud/models/info.rb +2 -2
  172. data/lib/ionoscloud/models/ip_block.rb +2 -2
  173. data/lib/ionoscloud/models/ip_block_properties.rb +2 -2
  174. data/lib/ionoscloud/models/ip_blocks.rb +2 -2
  175. data/lib/ionoscloud/models/ip_consumer.rb +2 -2
  176. data/lib/ionoscloud/models/ip_failover.rb +2 -2
  177. data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +12 -2
  178. data/lib/ionoscloud/models/kubernetes_cluster.rb +2 -2
  179. data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +2 -2
  180. data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +2 -2
  181. data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +2 -2
  182. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +3 -3
  183. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +3 -3
  184. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +3 -3
  185. data/lib/ionoscloud/models/kubernetes_clusters.rb +3 -3
  186. data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +12 -2
  187. data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
  188. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +4 -4
  189. data/lib/ionoscloud/models/kubernetes_node_pool.rb +2 -2
  190. data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +2 -2
  191. data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +2 -2
  192. data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +28 -6
  193. data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +229 -0
  194. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +2 -2
  195. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +2 -2
  196. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +2 -2
  197. data/lib/ionoscloud/models/kubernetes_node_pools.rb +3 -3
  198. data/lib/ionoscloud/models/kubernetes_node_properties.rb +2 -2
  199. data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
  200. data/lib/ionoscloud/models/label.rb +2 -2
  201. data/lib/ionoscloud/models/label_properties.rb +2 -2
  202. data/lib/ionoscloud/models/label_resource.rb +2 -2
  203. data/lib/ionoscloud/models/label_resource_properties.rb +2 -2
  204. data/lib/ionoscloud/models/label_resources.rb +2 -2
  205. data/lib/ionoscloud/models/labels.rb +2 -2
  206. data/lib/ionoscloud/models/lan.rb +2 -2
  207. data/lib/ionoscloud/models/lan_entities.rb +2 -2
  208. data/lib/ionoscloud/models/lan_nics.rb +2 -2
  209. data/lib/ionoscloud/models/lan_post.rb +2 -2
  210. data/lib/ionoscloud/models/lan_properties.rb +2 -2
  211. data/lib/ionoscloud/models/lan_properties_post.rb +2 -2
  212. data/lib/ionoscloud/models/lans.rb +3 -3
  213. data/lib/ionoscloud/models/loadbalancer.rb +2 -2
  214. data/lib/ionoscloud/models/loadbalancer_entities.rb +2 -2
  215. data/lib/ionoscloud/models/loadbalancer_properties.rb +2 -2
  216. data/lib/ionoscloud/models/loadbalancers.rb +2 -2
  217. data/lib/ionoscloud/models/location.rb +2 -2
  218. data/lib/ionoscloud/models/location_properties.rb +18 -6
  219. data/lib/ionoscloud/models/locations.rb +2 -2
  220. data/lib/ionoscloud/models/nat_gateway.rb +271 -0
  221. data/lib/ionoscloud/models/nat_gateway_entities.rb +227 -0
  222. data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +236 -0
  223. data/lib/ionoscloud/models/nat_gateway_properties.rb +253 -0
  224. data/lib/ionoscloud/models/nat_gateway_put.rb +253 -0
  225. data/lib/ionoscloud/models/nat_gateway_rule.rb +262 -0
  226. data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +293 -0
  227. data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +39 -0
  228. data/lib/ionoscloud/models/nat_gateway_rule_put.rb +253 -0
  229. data/lib/ionoscloud/models/nat_gateway_rule_type.rb +36 -0
  230. data/lib/ionoscloud/models/nat_gateway_rules.rb +251 -0
  231. data/lib/ionoscloud/models/nat_gateways.rb +280 -0
  232. data/lib/ionoscloud/models/network_load_balancer.rb +271 -0
  233. data/lib/ionoscloud/models/network_load_balancer_entities.rb +227 -0
  234. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +262 -0
  235. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +249 -0
  236. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +356 -0
  237. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +253 -0
  238. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +263 -0
  239. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +239 -0
  240. data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +280 -0
  241. data/lib/ionoscloud/models/network_load_balancer_properties.rb +278 -0
  242. data/lib/ionoscloud/models/network_load_balancer_put.rb +253 -0
  243. data/lib/ionoscloud/models/network_load_balancers.rb +280 -0
  244. data/lib/ionoscloud/models/nic.rb +2 -2
  245. data/lib/ionoscloud/models/nic_entities.rb +12 -3
  246. data/lib/ionoscloud/models/nic_properties.rb +64 -10
  247. data/lib/ionoscloud/models/nic_put.rb +253 -0
  248. data/lib/ionoscloud/models/nics.rb +2 -2
  249. data/lib/ionoscloud/models/no_state_meta_data.rb +2 -2
  250. data/lib/ionoscloud/models/pagination_links.rb +2 -2
  251. data/lib/ionoscloud/models/peer.rb +2 -2
  252. data/lib/ionoscloud/models/private_cross_connect.rb +2 -2
  253. data/lib/ionoscloud/models/private_cross_connect_properties.rb +3 -3
  254. data/lib/ionoscloud/models/private_cross_connects.rb +2 -2
  255. data/lib/ionoscloud/models/{kubernetes_config_properties.rb → remote_console_url.rb} +13 -13
  256. data/lib/ionoscloud/models/request.rb +2 -2
  257. data/lib/ionoscloud/models/request_metadata.rb +2 -2
  258. data/lib/ionoscloud/models/request_properties.rb +2 -2
  259. data/lib/ionoscloud/models/request_status.rb +2 -2
  260. data/lib/ionoscloud/models/request_status_metadata.rb +2 -2
  261. data/lib/ionoscloud/models/request_target.rb +2 -2
  262. data/lib/ionoscloud/models/requests.rb +2 -2
  263. data/lib/ionoscloud/models/resource.rb +2 -2
  264. data/lib/ionoscloud/models/resource_entities.rb +2 -2
  265. data/lib/ionoscloud/models/resource_groups.rb +2 -2
  266. data/lib/ionoscloud/models/resource_limits.rb +81 -6
  267. data/lib/ionoscloud/models/resource_properties.rb +3 -3
  268. data/lib/ionoscloud/models/resource_reference.rb +2 -2
  269. data/lib/ionoscloud/models/resources.rb +2 -2
  270. data/lib/ionoscloud/models/resources_users.rb +2 -2
  271. data/lib/ionoscloud/models/s3_bucket.rb +3 -3
  272. data/lib/ionoscloud/models/s3_key.rb +2 -2
  273. data/lib/ionoscloud/models/s3_key_metadata.rb +2 -2
  274. data/lib/ionoscloud/models/s3_key_properties.rb +2 -2
  275. data/lib/ionoscloud/models/s3_keys.rb +2 -2
  276. data/lib/ionoscloud/models/s3_object_storage_sso.rb +2 -2
  277. data/lib/ionoscloud/models/server.rb +2 -2
  278. data/lib/ionoscloud/models/server_entities.rb +2 -2
  279. data/lib/ionoscloud/models/server_properties.rb +27 -7
  280. data/lib/ionoscloud/models/servers.rb +2 -2
  281. data/lib/ionoscloud/models/snapshot.rb +2 -2
  282. data/lib/ionoscloud/models/snapshot_properties.rb +2 -2
  283. data/lib/ionoscloud/models/snapshots.rb +2 -2
  284. data/lib/ionoscloud/models/target_port_range.rb +229 -0
  285. data/lib/ionoscloud/models/template.rb +262 -0
  286. data/lib/ionoscloud/models/template_properties.rb +269 -0
  287. data/lib/ionoscloud/models/templates.rb +251 -0
  288. data/lib/ionoscloud/models/token.rb +219 -0
  289. data/lib/ionoscloud/models/type.rb +10 -2
  290. data/lib/ionoscloud/models/user.rb +2 -2
  291. data/lib/ionoscloud/models/user_metadata.rb +2 -2
  292. data/lib/ionoscloud/models/user_post.rb +2 -2
  293. data/lib/ionoscloud/models/user_properties.rb +2 -2
  294. data/lib/ionoscloud/models/user_properties_post.rb +2 -2
  295. data/lib/ionoscloud/models/user_properties_put.rb +2 -2
  296. data/lib/ionoscloud/models/user_put.rb +2 -2
  297. data/lib/ionoscloud/models/users.rb +2 -2
  298. data/lib/ionoscloud/models/users_entities.rb +2 -2
  299. data/lib/ionoscloud/models/volume.rb +2 -2
  300. data/lib/ionoscloud/models/volume_properties.rb +16 -6
  301. data/lib/ionoscloud/models/volumes.rb +2 -2
  302. data/lib/ionoscloud/version.rb +3 -3
  303. data/lib/ionoscloud.rb +60 -18
  304. data/spec/api/_api_spec.rb +5 -5
  305. data/spec/api/backup_units_api_spec.rb +140 -0
  306. data/spec/api/contract_resources_api_spec.rb +49 -0
  307. data/spec/api/data_centers_api_spec.rb +128 -0
  308. data/spec/api/firewall_rules_api_spec.rb +146 -0
  309. data/spec/api/flow_logs_api_spec.rb +140 -0
  310. data/spec/api/images_api_spec.rb +111 -0
  311. data/spec/api/ip_blocks_api_spec.rb +27 -27
  312. data/spec/api/kubernetes_api_spec.rb +55 -67
  313. data/spec/api/labels_api_spec.rb +474 -0
  314. data/spec/api/lans_api_spec.rb +186 -0
  315. data/spec/api/load_balancers_api_spec.rb +201 -0
  316. data/spec/api/locations_api_spec.rb +80 -0
  317. data/spec/api/nat_gateways_api_spec.rb +334 -0
  318. data/spec/api/network_interfaces_api_spec.rb +140 -0
  319. data/spec/api/network_load_balancers_api_spec.rb +340 -0
  320. data/spec/api/private_cross_connects_api_spec.rb +110 -0
  321. data/spec/api/{request_api_spec.rb → requests_api_spec.rb} +19 -19
  322. data/spec/api/servers_api_spec.rb +401 -0
  323. data/spec/api/snapshots_api_spec.rb +111 -0
  324. data/spec/api/templates_api_spec.rb +60 -0
  325. data/spec/api/user_management_api_spec.rb +81 -174
  326. data/spec/api/user_s3_keys_api_spec.rb +128 -0
  327. data/spec/api/volumes_api_spec.rb +171 -0
  328. data/spec/api_client_spec.rb +2 -2
  329. data/spec/configuration_spec.rb +5 -5
  330. data/spec/models/attached_volumes_spec.rb +2 -2
  331. data/spec/models/backup_unit_properties_spec.rb +2 -2
  332. data/spec/models/backup_unit_spec.rb +2 -2
  333. data/spec/models/backup_unit_sso_spec.rb +2 -2
  334. data/spec/models/backup_units_spec.rb +2 -2
  335. data/spec/models/balanced_nics_spec.rb +2 -2
  336. data/spec/models/cdroms_spec.rb +2 -2
  337. data/spec/models/connectable_datacenter_spec.rb +2 -2
  338. data/spec/models/contract_properties_spec.rb +2 -2
  339. data/spec/models/contract_spec.rb +2 -2
  340. data/spec/models/contracts_spec.rb +52 -0
  341. data/spec/models/cpu_architecture_properties_spec.rb +52 -0
  342. data/spec/models/data_center_entities_spec.rb +14 -2
  343. data/spec/models/datacenter_element_metadata_spec.rb +3 -3
  344. data/spec/models/datacenter_properties_spec.rb +8 -2
  345. data/spec/models/datacenter_spec.rb +2 -2
  346. data/spec/models/datacenters_spec.rb +2 -2
  347. data/spec/models/error_message_spec.rb +2 -2
  348. data/spec/models/error_spec.rb +2 -2
  349. data/spec/models/firewall_rule_spec.rb +2 -2
  350. data/spec/models/firewall_rules_spec.rb +2 -2
  351. data/spec/models/firewallrule_properties_spec.rb +12 -2
  352. data/spec/models/flow_log_properties_spec.rb +60 -0
  353. data/spec/models/flow_log_put_spec.rb +52 -0
  354. data/spec/models/flow_log_spec.rb +58 -0
  355. data/spec/models/flow_logs_spec.rb +70 -0
  356. data/spec/models/group_entities_spec.rb +2 -2
  357. data/spec/models/group_members_spec.rb +2 -2
  358. data/spec/models/group_properties_spec.rb +20 -2
  359. data/spec/models/group_share_properties_spec.rb +2 -2
  360. data/spec/models/group_share_spec.rb +2 -2
  361. data/spec/models/group_shares_spec.rb +2 -2
  362. data/spec/models/group_spec.rb +2 -2
  363. data/spec/models/group_users_spec.rb +2 -2
  364. data/spec/models/groups_spec.rb +2 -2
  365. data/spec/models/image_properties_spec.rb +2 -2
  366. data/spec/models/image_spec.rb +2 -2
  367. data/spec/models/images_spec.rb +2 -2
  368. data/spec/models/info_spec.rb +2 -2
  369. data/spec/models/ip_block_properties_spec.rb +2 -2
  370. data/spec/models/ip_block_spec.rb +2 -2
  371. data/spec/models/ip_blocks_spec.rb +2 -2
  372. data/spec/models/ip_consumer_spec.rb +2 -2
  373. data/spec/models/ip_failover_spec.rb +2 -2
  374. data/spec/models/kubernetes_auto_scaling_spec.rb +2 -2
  375. data/spec/models/kubernetes_cluster_entities_spec.rb +2 -2
  376. data/spec/models/kubernetes_cluster_for_post_spec.rb +2 -2
  377. data/spec/models/kubernetes_cluster_for_put_spec.rb +2 -2
  378. data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +2 -2
  379. data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +2 -2
  380. data/spec/models/kubernetes_cluster_properties_spec.rb +2 -2
  381. data/spec/models/kubernetes_cluster_spec.rb +2 -2
  382. data/spec/models/kubernetes_clusters_spec.rb +2 -2
  383. data/spec/models/kubernetes_maintenance_window_spec.rb +2 -2
  384. data/spec/models/kubernetes_node_metadata_spec.rb +3 -3
  385. data/spec/models/kubernetes_node_pool_for_post_spec.rb +2 -2
  386. data/spec/models/kubernetes_node_pool_for_put_spec.rb +2 -2
  387. data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +40 -0
  388. data/spec/models/kubernetes_node_pool_lan_spec.rb +14 -2
  389. data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +2 -2
  390. data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +2 -2
  391. data/spec/models/kubernetes_node_pool_properties_spec.rb +2 -2
  392. data/spec/models/kubernetes_node_pool_spec.rb +2 -2
  393. data/spec/models/kubernetes_node_pools_spec.rb +2 -2
  394. data/spec/models/kubernetes_node_properties_spec.rb +2 -2
  395. data/spec/models/kubernetes_node_spec.rb +2 -2
  396. data/spec/models/kubernetes_nodes_spec.rb +2 -2
  397. data/spec/models/label_properties_spec.rb +2 -2
  398. data/spec/models/label_resource_properties_spec.rb +2 -2
  399. data/spec/models/label_resource_spec.rb +2 -2
  400. data/spec/models/label_resources_spec.rb +2 -2
  401. data/spec/models/label_spec.rb +2 -2
  402. data/spec/models/labels_spec.rb +2 -2
  403. data/spec/models/lan_entities_spec.rb +2 -2
  404. data/spec/models/lan_nics_spec.rb +2 -2
  405. data/spec/models/lan_post_spec.rb +2 -2
  406. data/spec/models/lan_properties_post_spec.rb +2 -2
  407. data/spec/models/lan_properties_spec.rb +2 -2
  408. data/spec/models/lan_spec.rb +2 -2
  409. data/spec/models/lans_spec.rb +2 -2
  410. data/spec/models/loadbalancer_entities_spec.rb +2 -2
  411. data/spec/models/loadbalancer_properties_spec.rb +2 -2
  412. data/spec/models/loadbalancer_spec.rb +2 -2
  413. data/spec/models/loadbalancers_spec.rb +2 -2
  414. data/spec/models/location_properties_spec.rb +8 -2
  415. data/spec/models/location_spec.rb +2 -2
  416. data/spec/models/locations_spec.rb +2 -2
  417. data/spec/models/nat_gateway_entities_spec.rb +40 -0
  418. data/spec/models/nat_gateway_lan_properties_spec.rb +40 -0
  419. data/spec/models/nat_gateway_properties_spec.rb +46 -0
  420. data/spec/models/nat_gateway_put_spec.rb +52 -0
  421. data/spec/models/nat_gateway_rule_properties_spec.rb +70 -0
  422. data/spec/models/nat_gateway_rule_protocol_spec.rb +28 -0
  423. data/spec/models/nat_gateway_rule_put_spec.rb +52 -0
  424. data/spec/models/nat_gateway_rule_spec.rb +58 -0
  425. data/spec/models/nat_gateway_rule_type_spec.rb +28 -0
  426. data/spec/models/nat_gateway_rules_spec.rb +52 -0
  427. data/spec/models/nat_gateway_spec.rb +64 -0
  428. data/spec/models/nat_gateways_spec.rb +70 -0
  429. data/spec/models/network_load_balancer_entities_spec.rb +40 -0
  430. data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +52 -0
  431. data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +78 -0
  432. data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +52 -0
  433. data/spec/models/network_load_balancer_forwarding_rule_spec.rb +58 -0
  434. data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +46 -0
  435. data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +52 -0
  436. data/spec/models/network_load_balancer_forwarding_rules_spec.rb +70 -0
  437. data/spec/models/network_load_balancer_properties_spec.rb +58 -0
  438. data/spec/models/network_load_balancer_put_spec.rb +52 -0
  439. data/spec/models/network_load_balancer_spec.rb +64 -0
  440. data/spec/models/network_load_balancers_spec.rb +70 -0
  441. data/spec/models/nic_entities_spec.rb +8 -2
  442. data/spec/models/nic_properties_spec.rb +19 -3
  443. data/spec/models/nic_put_spec.rb +52 -0
  444. data/spec/models/nic_spec.rb +2 -2
  445. data/spec/models/nics_spec.rb +2 -2
  446. data/spec/models/no_state_meta_data_spec.rb +2 -2
  447. data/spec/models/pagination_links_spec.rb +2 -2
  448. data/spec/models/peer_spec.rb +2 -2
  449. data/spec/models/private_cross_connect_properties_spec.rb +2 -2
  450. data/spec/models/private_cross_connect_spec.rb +2 -2
  451. data/spec/models/private_cross_connects_spec.rb +2 -2
  452. data/spec/models/remote_console_url_spec.rb +34 -0
  453. data/spec/models/request_metadata_spec.rb +2 -2
  454. data/spec/models/request_properties_spec.rb +2 -2
  455. data/spec/models/request_spec.rb +2 -2
  456. data/spec/models/request_status_metadata_spec.rb +2 -2
  457. data/spec/models/request_status_spec.rb +2 -2
  458. data/spec/models/request_target_spec.rb +2 -2
  459. data/spec/models/requests_spec.rb +2 -2
  460. data/spec/models/resource_entities_spec.rb +2 -2
  461. data/spec/models/resource_groups_spec.rb +2 -2
  462. data/spec/models/resource_limits_spec.rb +32 -2
  463. data/spec/models/resource_properties_spec.rb +2 -2
  464. data/spec/models/resource_reference_spec.rb +2 -2
  465. data/spec/models/resource_spec.rb +2 -2
  466. data/spec/models/resources_spec.rb +2 -2
  467. data/spec/models/resources_users_spec.rb +2 -2
  468. data/spec/models/s3_bucket_spec.rb +2 -2
  469. data/spec/models/s3_key_metadata_spec.rb +2 -2
  470. data/spec/models/s3_key_properties_spec.rb +2 -2
  471. data/spec/models/s3_key_spec.rb +2 -2
  472. data/spec/models/s3_keys_spec.rb +2 -2
  473. data/spec/models/s3_object_storage_sso_spec.rb +2 -2
  474. data/spec/models/server_entities_spec.rb +2 -2
  475. data/spec/models/server_properties_spec.rb +14 -2
  476. data/spec/models/server_spec.rb +2 -2
  477. data/spec/models/servers_spec.rb +2 -2
  478. data/spec/models/snapshot_properties_spec.rb +2 -2
  479. data/spec/models/snapshot_spec.rb +2 -2
  480. data/spec/models/snapshots_spec.rb +2 -2
  481. data/spec/models/target_port_range_spec.rb +40 -0
  482. data/spec/models/template_properties_spec.rb +52 -0
  483. data/spec/models/template_spec.rb +58 -0
  484. data/spec/models/templates_spec.rb +52 -0
  485. data/spec/models/token_spec.rb +34 -0
  486. data/spec/models/type_spec.rb +2 -2
  487. data/spec/models/user_metadata_spec.rb +2 -2
  488. data/spec/models/user_post_spec.rb +2 -2
  489. data/spec/models/user_properties_post_spec.rb +2 -2
  490. data/spec/models/user_properties_put_spec.rb +2 -2
  491. data/spec/models/user_properties_spec.rb +2 -2
  492. data/spec/models/user_put_spec.rb +2 -2
  493. data/spec/models/user_spec.rb +2 -2
  494. data/spec/models/users_entities_spec.rb +2 -2
  495. data/spec/models/users_spec.rb +2 -2
  496. data/spec/models/volume_properties_spec.rb +8 -2
  497. data/spec/models/volume_spec.rb +2 -2
  498. data/spec/models/volumes_spec.rb +2 -2
  499. data/spec/spec_helper.rb +2 -2
  500. metadata +246 -80
  501. data/Gemfile.lock +0 -68
  502. data/docs/api/BackupUnitApi.md +0 -595
  503. data/docs/api/ContractApi.md +0 -89
  504. data/docs/api/DataCenterApi.md +0 -517
  505. data/docs/api/ImageApi.md +0 -429
  506. data/docs/api/LabelApi.md +0 -2355
  507. data/docs/api/LanApi.md +0 -795
  508. data/docs/api/LoadBalancerApi.md +0 -883
  509. data/docs/api/LocationApi.md +0 -259
  510. data/docs/api/NicApi.md +0 -1087
  511. data/docs/api/PrivateCrossConnectApi.md +0 -427
  512. data/docs/api/ServerApi.md +0 -1573
  513. data/docs/api/SnapshotApi.md +0 -429
  514. data/docs/api/VolumeApi.md +0 -711
  515. data/docs/models/KubernetesConfig.md +0 -24
  516. data/docs/models/KubernetesConfigProperties.md +0 -18
  517. data/lib/ionoscloud/api/contract_api.rb +0 -96
  518. data/lib/ionoscloud/api/data_center_api.rb +0 -532
  519. data/lib/ionoscloud/api/nic_api.rb +0 -1222
  520. data/lib/ionoscloud/api/server_api.rb +0 -1679
  521. data/lib/test_driver.rb +0 -104
  522. data/spec/api/backup_unit_api_spec.rb +0 -140
  523. data/spec/api/contract_api_spec.rb +0 -49
  524. data/spec/api/data_center_api_spec.rb +0 -128
  525. data/spec/api/image_api_spec.rb +0 -111
  526. data/spec/api/label_api_spec.rb +0 -480
  527. data/spec/api/lan_api_spec.rb +0 -186
  528. data/spec/api/load_balancer_api_spec.rb +0 -203
  529. data/spec/api/location_api_spec.rb +0 -80
  530. data/spec/api/nic_api_spec.rb +0 -251
  531. data/spec/api/private_cross_connect_api_spec.rb +0 -110
  532. data/spec/api/server_api_spec.rb +0 -337
  533. data/spec/api/snapshot_api_spec.rb +0 -111
  534. data/spec/api/volume_api_spec.rb +0 -171
  535. data/spec/models/kubernetes_config_properties_spec.rb +0 -34
  536. data/spec/models/kubernetes_config_spec.rb +0 -56
@@ -0,0 +1,2338 @@
1
+ # LabelsApi
2
+
3
+ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**datacenters_labels_delete**](LabelsApi.md#datacenters_labels_delete) | **DELETE** /datacenters/{datacenterId}/labels/{key} | Delete a Label from Data Center |
8
+ | [**datacenters_labels_find_by_key**](LabelsApi.md#datacenters_labels_find_by_key) | **GET** /datacenters/{datacenterId}/labels/{key} | Retrieve a Label of Data Center |
9
+ | [**datacenters_labels_get**](LabelsApi.md#datacenters_labels_get) | **GET** /datacenters/{datacenterId}/labels | List all Data Center Labels |
10
+ | [**datacenters_labels_post**](LabelsApi.md#datacenters_labels_post) | **POST** /datacenters/{datacenterId}/labels | Add a Label to Data Center |
11
+ | [**datacenters_labels_put**](LabelsApi.md#datacenters_labels_put) | **PUT** /datacenters/{datacenterId}/labels/{key} | Modify a Label of Data Center |
12
+ | [**datacenters_servers_labels_delete**](LabelsApi.md#datacenters_servers_labels_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Delete a Label from Server |
13
+ | [**datacenters_servers_labels_find_by_key**](LabelsApi.md#datacenters_servers_labels_find_by_key) | **GET** /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Retrieve a Label of Server |
14
+ | [**datacenters_servers_labels_get**](LabelsApi.md#datacenters_servers_labels_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/labels | List all Server Labels |
15
+ | [**datacenters_servers_labels_post**](LabelsApi.md#datacenters_servers_labels_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/labels | Add a Label to Server |
16
+ | [**datacenters_servers_labels_put**](LabelsApi.md#datacenters_servers_labels_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Modify a Label of Server |
17
+ | [**datacenters_volumes_labels_delete**](LabelsApi.md#datacenters_volumes_labels_delete) | **DELETE** /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Delete a Label from Volume |
18
+ | [**datacenters_volumes_labels_find_by_key**](LabelsApi.md#datacenters_volumes_labels_find_by_key) | **GET** /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Retrieve a Label of Volume |
19
+ | [**datacenters_volumes_labels_get**](LabelsApi.md#datacenters_volumes_labels_get) | **GET** /datacenters/{datacenterId}/volumes/{volumeId}/labels | List all Volume Labels |
20
+ | [**datacenters_volumes_labels_post**](LabelsApi.md#datacenters_volumes_labels_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/labels | Add a Label to Volume |
21
+ | [**datacenters_volumes_labels_put**](LabelsApi.md#datacenters_volumes_labels_put) | **PUT** /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Modify a Label of Volume |
22
+ | [**ipblocks_labels_delete**](LabelsApi.md#ipblocks_labels_delete) | **DELETE** /ipblocks/{ipblockId}/labels/{key} | Delete a Label from IP Block |
23
+ | [**ipblocks_labels_find_by_key**](LabelsApi.md#ipblocks_labels_find_by_key) | **GET** /ipblocks/{ipblockId}/labels/{key} | Retrieve a Label of IP Block |
24
+ | [**ipblocks_labels_get**](LabelsApi.md#ipblocks_labels_get) | **GET** /ipblocks/{ipblockId}/labels | List all Ip Block Labels |
25
+ | [**ipblocks_labels_post**](LabelsApi.md#ipblocks_labels_post) | **POST** /ipblocks/{ipblockId}/labels | Add a Label to IP Block |
26
+ | [**ipblocks_labels_put**](LabelsApi.md#ipblocks_labels_put) | **PUT** /ipblocks/{ipblockId}/labels/{key} | Modify a Label of IP Block |
27
+ | [**labels_find_by_urn**](LabelsApi.md#labels_find_by_urn) | **GET** /labels/{labelurn} | Returns the label by its URN. |
28
+ | [**labels_get**](LabelsApi.md#labels_get) | **GET** /labels | List Labels |
29
+ | [**snapshots_labels_delete**](LabelsApi.md#snapshots_labels_delete) | **DELETE** /snapshots/{snapshotId}/labels/{key} | Delete a Label from Snapshot |
30
+ | [**snapshots_labels_find_by_key**](LabelsApi.md#snapshots_labels_find_by_key) | **GET** /snapshots/{snapshotId}/labels/{key} | Retrieve a Label of Snapshot |
31
+ | [**snapshots_labels_get**](LabelsApi.md#snapshots_labels_get) | **GET** /snapshots/{snapshotId}/labels | List all Snapshot Labels |
32
+ | [**snapshots_labels_post**](LabelsApi.md#snapshots_labels_post) | **POST** /snapshots/{snapshotId}/labels | Add a Label to Snapshot |
33
+ | [**snapshots_labels_put**](LabelsApi.md#snapshots_labels_put) | **PUT** /snapshots/{snapshotId}/labels/{key} | Modify a Label of Snapshot |
34
+
35
+
36
+ ## datacenters_labels_delete
37
+
38
+ > datacenters_labels_delete(datacenter_id, key, opts)
39
+
40
+ Delete a Label from Data Center
41
+
42
+ This will remove a label from the data center.
43
+
44
+ ### Examples
45
+
46
+ ```ruby
47
+ require 'time'
48
+ require 'ionoscloud'
49
+ # setup authorization
50
+ Ionoscloud.configure do |config|
51
+ # Configure HTTP basic authorization: Basic Authentication
52
+ config.username = 'YOUR USERNAME'
53
+ config.password = 'YOUR PASSWORD'
54
+
55
+ # Configure API key authorization: Token Authentication
56
+ config.api_key['Authorization'] = 'YOUR API KEY'
57
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
58
+ # config.api_key_prefix['Authorization'] = 'Bearer'
59
+ end
60
+
61
+ api_instance = Ionoscloud::LabelsApi.new
62
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
63
+ key = 'key_example' # String | The key of the Label
64
+ opts = {
65
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
66
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
67
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
68
+ }
69
+
70
+ begin
71
+ # Delete a Label from Data Center
72
+ api_instance.datacenters_labels_delete(datacenter_id, key, opts)
73
+ rescue Ionoscloud::ApiError => e
74
+ puts "Error when calling LabelsApi->datacenters_labels_delete: #{e}"
75
+ end
76
+ ```
77
+
78
+ #### Using the datacenters_labels_delete_with_http_info variant
79
+
80
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
81
+
82
+ > <Array(nil, Integer, Hash)> datacenters_labels_delete_with_http_info(datacenter_id, key, opts)
83
+
84
+ ```ruby
85
+ begin
86
+ # Delete a Label from Data Center
87
+ data, status_code, headers = api_instance.datacenters_labels_delete_with_http_info(datacenter_id, key, opts)
88
+ p status_code # => 2xx
89
+ p headers # => { ... }
90
+ p data # => nil
91
+ rescue Ionoscloud::ApiError => e
92
+ puts "Error when calling LabelsApi->datacenters_labels_delete_with_http_info: #{e}"
93
+ end
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ | Name | Type | Description | Notes |
99
+ | ---- | ---- | ----------- | ----- |
100
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
101
+ | **key** | **String** | The key of the Label | |
102
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
103
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
104
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
105
+
106
+ ### Return type
107
+
108
+ nil (empty response body)
109
+
110
+ ### Authorization
111
+
112
+ Basic Authentication, Token Authentication
113
+
114
+ ### HTTP request headers
115
+
116
+ - **Content-Type**: Not defined
117
+ - **Accept**: application/json
118
+
119
+
120
+ ## datacenters_labels_find_by_key
121
+
122
+ > <LabelResource> datacenters_labels_find_by_key(datacenter_id, key, opts)
123
+
124
+ Retrieve a Label of Data Center
125
+
126
+ This will retrieve the properties of a associated label to a data center.
127
+
128
+ ### Examples
129
+
130
+ ```ruby
131
+ require 'time'
132
+ require 'ionoscloud'
133
+ # setup authorization
134
+ Ionoscloud.configure do |config|
135
+ # Configure HTTP basic authorization: Basic Authentication
136
+ config.username = 'YOUR USERNAME'
137
+ config.password = 'YOUR PASSWORD'
138
+
139
+ # Configure API key authorization: Token Authentication
140
+ config.api_key['Authorization'] = 'YOUR API KEY'
141
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
142
+ # config.api_key_prefix['Authorization'] = 'Bearer'
143
+ end
144
+
145
+ api_instance = Ionoscloud::LabelsApi.new
146
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
147
+ key = 'key_example' # String | The key of the Label
148
+ opts = {
149
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
150
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
151
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
152
+ }
153
+
154
+ begin
155
+ # Retrieve a Label of Data Center
156
+ result = api_instance.datacenters_labels_find_by_key(datacenter_id, key, opts)
157
+ p result
158
+ rescue Ionoscloud::ApiError => e
159
+ puts "Error when calling LabelsApi->datacenters_labels_find_by_key: #{e}"
160
+ end
161
+ ```
162
+
163
+ #### Using the datacenters_labels_find_by_key_with_http_info variant
164
+
165
+ This returns an Array which contains the response data, status code and headers.
166
+
167
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_labels_find_by_key_with_http_info(datacenter_id, key, opts)
168
+
169
+ ```ruby
170
+ begin
171
+ # Retrieve a Label of Data Center
172
+ data, status_code, headers = api_instance.datacenters_labels_find_by_key_with_http_info(datacenter_id, key, opts)
173
+ p status_code # => 2xx
174
+ p headers # => { ... }
175
+ p data # => <LabelResource>
176
+ rescue Ionoscloud::ApiError => e
177
+ puts "Error when calling LabelsApi->datacenters_labels_find_by_key_with_http_info: #{e}"
178
+ end
179
+ ```
180
+
181
+ ### Parameters
182
+
183
+ | Name | Type | Description | Notes |
184
+ | ---- | ---- | ----------- | ----- |
185
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
186
+ | **key** | **String** | The key of the Label | |
187
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
188
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
190
+
191
+ ### Return type
192
+
193
+ [**LabelResource**](LabelResource.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_labels_get
206
+
207
+ > <LabelResources> datacenters_labels_get(datacenter_id, opts)
208
+
209
+ List all Data Center Labels
210
+
211
+ You can retrieve a list of all labels associated with a data center.
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::LabelsApi.new
231
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
232
+ opts = {
233
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
234
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
235
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
236
+ }
237
+
238
+ begin
239
+ # List all Data Center Labels
240
+ result = api_instance.datacenters_labels_get(datacenter_id, opts)
241
+ p result
242
+ rescue Ionoscloud::ApiError => e
243
+ puts "Error when calling LabelsApi->datacenters_labels_get: #{e}"
244
+ end
245
+ ```
246
+
247
+ #### Using the datacenters_labels_get_with_http_info variant
248
+
249
+ This returns an Array which contains the response data, status code and headers.
250
+
251
+ > <Array(<LabelResources>, Integer, Hash)> datacenters_labels_get_with_http_info(datacenter_id, opts)
252
+
253
+ ```ruby
254
+ begin
255
+ # List all Data Center Labels
256
+ data, status_code, headers = api_instance.datacenters_labels_get_with_http_info(datacenter_id, opts)
257
+ p status_code # => 2xx
258
+ p headers # => { ... }
259
+ p data # => <LabelResources>
260
+ rescue Ionoscloud::ApiError => e
261
+ puts "Error when calling LabelsApi->datacenters_labels_get_with_http_info: #{e}"
262
+ end
263
+ ```
264
+
265
+ ### Parameters
266
+
267
+ | Name | Type | Description | Notes |
268
+ | ---- | ---- | ----------- | ----- |
269
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
270
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
271
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
272
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
273
+
274
+ ### Return type
275
+
276
+ [**LabelResources**](LabelResources.md)
277
+
278
+ ### Authorization
279
+
280
+ Basic Authentication, Token Authentication
281
+
282
+ ### HTTP request headers
283
+
284
+ - **Content-Type**: Not defined
285
+ - **Accept**: application/json
286
+
287
+
288
+ ## datacenters_labels_post
289
+
290
+ > <LabelResource> datacenters_labels_post(datacenter_id, label, opts)
291
+
292
+ Add a Label to Data Center
293
+
294
+ This will add a label to the data center.
295
+
296
+ ### Examples
297
+
298
+ ```ruby
299
+ require 'time'
300
+ require 'ionoscloud'
301
+ # setup authorization
302
+ Ionoscloud.configure do |config|
303
+ # Configure HTTP basic authorization: Basic Authentication
304
+ config.username = 'YOUR USERNAME'
305
+ config.password = 'YOUR PASSWORD'
306
+
307
+ # Configure API key authorization: Token Authentication
308
+ config.api_key['Authorization'] = 'YOUR API KEY'
309
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
310
+ # config.api_key_prefix['Authorization'] = 'Bearer'
311
+ end
312
+
313
+ api_instance = Ionoscloud::LabelsApi.new
314
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
315
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
316
+ opts = {
317
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
318
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
319
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
320
+ }
321
+
322
+ begin
323
+ # Add a Label to Data Center
324
+ result = api_instance.datacenters_labels_post(datacenter_id, label, opts)
325
+ p result
326
+ rescue Ionoscloud::ApiError => e
327
+ puts "Error when calling LabelsApi->datacenters_labels_post: #{e}"
328
+ end
329
+ ```
330
+
331
+ #### Using the datacenters_labels_post_with_http_info variant
332
+
333
+ This returns an Array which contains the response data, status code and headers.
334
+
335
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_labels_post_with_http_info(datacenter_id, label, opts)
336
+
337
+ ```ruby
338
+ begin
339
+ # Add a Label to Data Center
340
+ data, status_code, headers = api_instance.datacenters_labels_post_with_http_info(datacenter_id, label, opts)
341
+ p status_code # => 2xx
342
+ p headers # => { ... }
343
+ p data # => <LabelResource>
344
+ rescue Ionoscloud::ApiError => e
345
+ puts "Error when calling LabelsApi->datacenters_labels_post_with_http_info: #{e}"
346
+ end
347
+ ```
348
+
349
+ ### Parameters
350
+
351
+ | Name | Type | Description | Notes |
352
+ | ---- | ---- | ----------- | ----- |
353
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
354
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
355
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
356
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
357
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
358
+
359
+ ### Return type
360
+
361
+ [**LabelResource**](LabelResource.md)
362
+
363
+ ### Authorization
364
+
365
+ Basic Authentication, Token Authentication
366
+
367
+ ### HTTP request headers
368
+
369
+ - **Content-Type**: application/json
370
+ - **Accept**: application/json
371
+
372
+
373
+ ## datacenters_labels_put
374
+
375
+ > <LabelResource> datacenters_labels_put(datacenter_id, key, label, opts)
376
+
377
+ Modify a Label of Data Center
378
+
379
+ This will modify the value of the label on a data center.
380
+
381
+ ### Examples
382
+
383
+ ```ruby
384
+ require 'time'
385
+ require 'ionoscloud'
386
+ # setup authorization
387
+ Ionoscloud.configure do |config|
388
+ # Configure HTTP basic authorization: Basic Authentication
389
+ config.username = 'YOUR USERNAME'
390
+ config.password = 'YOUR PASSWORD'
391
+
392
+ # Configure API key authorization: Token Authentication
393
+ config.api_key['Authorization'] = 'YOUR API KEY'
394
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
395
+ # config.api_key_prefix['Authorization'] = 'Bearer'
396
+ end
397
+
398
+ api_instance = Ionoscloud::LabelsApi.new
399
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
400
+ key = 'key_example' # String | The key of the Label
401
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
402
+ opts = {
403
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
404
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
405
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
406
+ }
407
+
408
+ begin
409
+ # Modify a Label of Data Center
410
+ result = api_instance.datacenters_labels_put(datacenter_id, key, label, opts)
411
+ p result
412
+ rescue Ionoscloud::ApiError => e
413
+ puts "Error when calling LabelsApi->datacenters_labels_put: #{e}"
414
+ end
415
+ ```
416
+
417
+ #### Using the datacenters_labels_put_with_http_info variant
418
+
419
+ This returns an Array which contains the response data, status code and headers.
420
+
421
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_labels_put_with_http_info(datacenter_id, key, label, opts)
422
+
423
+ ```ruby
424
+ begin
425
+ # Modify a Label of Data Center
426
+ data, status_code, headers = api_instance.datacenters_labels_put_with_http_info(datacenter_id, key, label, opts)
427
+ p status_code # => 2xx
428
+ p headers # => { ... }
429
+ p data # => <LabelResource>
430
+ rescue Ionoscloud::ApiError => e
431
+ puts "Error when calling LabelsApi->datacenters_labels_put_with_http_info: #{e}"
432
+ end
433
+ ```
434
+
435
+ ### Parameters
436
+
437
+ | Name | Type | Description | Notes |
438
+ | ---- | ---- | ----------- | ----- |
439
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
440
+ | **key** | **String** | The key of the Label | |
441
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
442
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
443
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
444
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
445
+
446
+ ### Return type
447
+
448
+ [**LabelResource**](LabelResource.md)
449
+
450
+ ### Authorization
451
+
452
+ Basic Authentication, Token Authentication
453
+
454
+ ### HTTP request headers
455
+
456
+ - **Content-Type**: application/json
457
+ - **Accept**: application/json
458
+
459
+
460
+ ## datacenters_servers_labels_delete
461
+
462
+ > datacenters_servers_labels_delete(datacenter_id, server_id, key, opts)
463
+
464
+ Delete a Label from Server
465
+
466
+ This will remove a label from the server.
467
+
468
+ ### Examples
469
+
470
+ ```ruby
471
+ require 'time'
472
+ require 'ionoscloud'
473
+ # setup authorization
474
+ Ionoscloud.configure do |config|
475
+ # Configure HTTP basic authorization: Basic Authentication
476
+ config.username = 'YOUR USERNAME'
477
+ config.password = 'YOUR PASSWORD'
478
+
479
+ # Configure API key authorization: Token Authentication
480
+ config.api_key['Authorization'] = 'YOUR API KEY'
481
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
482
+ # config.api_key_prefix['Authorization'] = 'Bearer'
483
+ end
484
+
485
+ api_instance = Ionoscloud::LabelsApi.new
486
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
487
+ server_id = 'server_id_example' # String | The unique ID of the Server
488
+ key = 'key_example' # String | The key of the Label
489
+ opts = {
490
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
491
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
492
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
493
+ }
494
+
495
+ begin
496
+ # Delete a Label from Server
497
+ api_instance.datacenters_servers_labels_delete(datacenter_id, server_id, key, opts)
498
+ rescue Ionoscloud::ApiError => e
499
+ puts "Error when calling LabelsApi->datacenters_servers_labels_delete: #{e}"
500
+ end
501
+ ```
502
+
503
+ #### Using the datacenters_servers_labels_delete_with_http_info variant
504
+
505
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
506
+
507
+ > <Array(nil, Integer, Hash)> datacenters_servers_labels_delete_with_http_info(datacenter_id, server_id, key, opts)
508
+
509
+ ```ruby
510
+ begin
511
+ # Delete a Label from Server
512
+ data, status_code, headers = api_instance.datacenters_servers_labels_delete_with_http_info(datacenter_id, server_id, key, opts)
513
+ p status_code # => 2xx
514
+ p headers # => { ... }
515
+ p data # => nil
516
+ rescue Ionoscloud::ApiError => e
517
+ puts "Error when calling LabelsApi->datacenters_servers_labels_delete_with_http_info: #{e}"
518
+ end
519
+ ```
520
+
521
+ ### Parameters
522
+
523
+ | Name | Type | Description | Notes |
524
+ | ---- | ---- | ----------- | ----- |
525
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
526
+ | **server_id** | **String** | The unique ID of the Server | |
527
+ | **key** | **String** | The key of the Label | |
528
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
529
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
530
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
531
+
532
+ ### Return type
533
+
534
+ nil (empty response body)
535
+
536
+ ### Authorization
537
+
538
+ Basic Authentication, Token Authentication
539
+
540
+ ### HTTP request headers
541
+
542
+ - **Content-Type**: Not defined
543
+ - **Accept**: application/json
544
+
545
+
546
+ ## datacenters_servers_labels_find_by_key
547
+
548
+ > <LabelResource> datacenters_servers_labels_find_by_key(datacenter_id, server_id, key, opts)
549
+
550
+ Retrieve a Label of Server
551
+
552
+ This will retrieve the properties of a associated label to a server.
553
+
554
+ ### Examples
555
+
556
+ ```ruby
557
+ require 'time'
558
+ require 'ionoscloud'
559
+ # setup authorization
560
+ Ionoscloud.configure do |config|
561
+ # Configure HTTP basic authorization: Basic Authentication
562
+ config.username = 'YOUR USERNAME'
563
+ config.password = 'YOUR PASSWORD'
564
+
565
+ # Configure API key authorization: Token Authentication
566
+ config.api_key['Authorization'] = 'YOUR API KEY'
567
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
568
+ # config.api_key_prefix['Authorization'] = 'Bearer'
569
+ end
570
+
571
+ api_instance = Ionoscloud::LabelsApi.new
572
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
573
+ server_id = 'server_id_example' # String | The unique ID of the Server
574
+ key = 'key_example' # String | The key of the Label
575
+ opts = {
576
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
577
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
578
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
579
+ }
580
+
581
+ begin
582
+ # Retrieve a Label of Server
583
+ result = api_instance.datacenters_servers_labels_find_by_key(datacenter_id, server_id, key, opts)
584
+ p result
585
+ rescue Ionoscloud::ApiError => e
586
+ puts "Error when calling LabelsApi->datacenters_servers_labels_find_by_key: #{e}"
587
+ end
588
+ ```
589
+
590
+ #### Using the datacenters_servers_labels_find_by_key_with_http_info variant
591
+
592
+ This returns an Array which contains the response data, status code and headers.
593
+
594
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_servers_labels_find_by_key_with_http_info(datacenter_id, server_id, key, opts)
595
+
596
+ ```ruby
597
+ begin
598
+ # Retrieve a Label of Server
599
+ data, status_code, headers = api_instance.datacenters_servers_labels_find_by_key_with_http_info(datacenter_id, server_id, key, opts)
600
+ p status_code # => 2xx
601
+ p headers # => { ... }
602
+ p data # => <LabelResource>
603
+ rescue Ionoscloud::ApiError => e
604
+ puts "Error when calling LabelsApi->datacenters_servers_labels_find_by_key_with_http_info: #{e}"
605
+ end
606
+ ```
607
+
608
+ ### Parameters
609
+
610
+ | Name | Type | Description | Notes |
611
+ | ---- | ---- | ----------- | ----- |
612
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
613
+ | **server_id** | **String** | The unique ID of the Server | |
614
+ | **key** | **String** | The key of the Label | |
615
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
616
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
617
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
618
+
619
+ ### Return type
620
+
621
+ [**LabelResource**](LabelResource.md)
622
+
623
+ ### Authorization
624
+
625
+ Basic Authentication, Token Authentication
626
+
627
+ ### HTTP request headers
628
+
629
+ - **Content-Type**: Not defined
630
+ - **Accept**: application/json
631
+
632
+
633
+ ## datacenters_servers_labels_get
634
+
635
+ > <LabelResources> datacenters_servers_labels_get(datacenter_id, server_id, opts)
636
+
637
+ List all Server Labels
638
+
639
+ You can retrieve a list of all labels associated with a server.
640
+
641
+ ### Examples
642
+
643
+ ```ruby
644
+ require 'time'
645
+ require 'ionoscloud'
646
+ # setup authorization
647
+ Ionoscloud.configure do |config|
648
+ # Configure HTTP basic authorization: Basic Authentication
649
+ config.username = 'YOUR USERNAME'
650
+ config.password = 'YOUR PASSWORD'
651
+
652
+ # Configure API key authorization: Token Authentication
653
+ config.api_key['Authorization'] = 'YOUR API KEY'
654
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
655
+ # config.api_key_prefix['Authorization'] = 'Bearer'
656
+ end
657
+
658
+ api_instance = Ionoscloud::LabelsApi.new
659
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
660
+ server_id = 'server_id_example' # String | The unique ID of the Server
661
+ opts = {
662
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
663
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
664
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
665
+ }
666
+
667
+ begin
668
+ # List all Server Labels
669
+ result = api_instance.datacenters_servers_labels_get(datacenter_id, server_id, opts)
670
+ p result
671
+ rescue Ionoscloud::ApiError => e
672
+ puts "Error when calling LabelsApi->datacenters_servers_labels_get: #{e}"
673
+ end
674
+ ```
675
+
676
+ #### Using the datacenters_servers_labels_get_with_http_info variant
677
+
678
+ This returns an Array which contains the response data, status code and headers.
679
+
680
+ > <Array(<LabelResources>, Integer, Hash)> datacenters_servers_labels_get_with_http_info(datacenter_id, server_id, opts)
681
+
682
+ ```ruby
683
+ begin
684
+ # List all Server Labels
685
+ data, status_code, headers = api_instance.datacenters_servers_labels_get_with_http_info(datacenter_id, server_id, opts)
686
+ p status_code # => 2xx
687
+ p headers # => { ... }
688
+ p data # => <LabelResources>
689
+ rescue Ionoscloud::ApiError => e
690
+ puts "Error when calling LabelsApi->datacenters_servers_labels_get_with_http_info: #{e}"
691
+ end
692
+ ```
693
+
694
+ ### Parameters
695
+
696
+ | Name | Type | Description | Notes |
697
+ | ---- | ---- | ----------- | ----- |
698
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
699
+ | **server_id** | **String** | The unique ID of the Server | |
700
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
701
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
702
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
703
+
704
+ ### Return type
705
+
706
+ [**LabelResources**](LabelResources.md)
707
+
708
+ ### Authorization
709
+
710
+ Basic Authentication, Token Authentication
711
+
712
+ ### HTTP request headers
713
+
714
+ - **Content-Type**: Not defined
715
+ - **Accept**: application/json
716
+
717
+
718
+ ## datacenters_servers_labels_post
719
+
720
+ > <LabelResource> datacenters_servers_labels_post(datacenter_id, server_id, label, opts)
721
+
722
+ Add a Label to Server
723
+
724
+ This will add a label to the server.
725
+
726
+ ### Examples
727
+
728
+ ```ruby
729
+ require 'time'
730
+ require 'ionoscloud'
731
+ # setup authorization
732
+ Ionoscloud.configure do |config|
733
+ # Configure HTTP basic authorization: Basic Authentication
734
+ config.username = 'YOUR USERNAME'
735
+ config.password = 'YOUR PASSWORD'
736
+
737
+ # Configure API key authorization: Token Authentication
738
+ config.api_key['Authorization'] = 'YOUR API KEY'
739
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
740
+ # config.api_key_prefix['Authorization'] = 'Bearer'
741
+ end
742
+
743
+ api_instance = Ionoscloud::LabelsApi.new
744
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
745
+ server_id = 'server_id_example' # String | The unique ID of the Server
746
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
747
+ opts = {
748
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
749
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
750
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
751
+ }
752
+
753
+ begin
754
+ # Add a Label to Server
755
+ result = api_instance.datacenters_servers_labels_post(datacenter_id, server_id, label, opts)
756
+ p result
757
+ rescue Ionoscloud::ApiError => e
758
+ puts "Error when calling LabelsApi->datacenters_servers_labels_post: #{e}"
759
+ end
760
+ ```
761
+
762
+ #### Using the datacenters_servers_labels_post_with_http_info variant
763
+
764
+ This returns an Array which contains the response data, status code and headers.
765
+
766
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_servers_labels_post_with_http_info(datacenter_id, server_id, label, opts)
767
+
768
+ ```ruby
769
+ begin
770
+ # Add a Label to Server
771
+ data, status_code, headers = api_instance.datacenters_servers_labels_post_with_http_info(datacenter_id, server_id, label, opts)
772
+ p status_code # => 2xx
773
+ p headers # => { ... }
774
+ p data # => <LabelResource>
775
+ rescue Ionoscloud::ApiError => e
776
+ puts "Error when calling LabelsApi->datacenters_servers_labels_post_with_http_info: #{e}"
777
+ end
778
+ ```
779
+
780
+ ### Parameters
781
+
782
+ | Name | Type | Description | Notes |
783
+ | ---- | ---- | ----------- | ----- |
784
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
785
+ | **server_id** | **String** | The unique ID of the Server | |
786
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
787
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
788
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
789
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
790
+
791
+ ### Return type
792
+
793
+ [**LabelResource**](LabelResource.md)
794
+
795
+ ### Authorization
796
+
797
+ Basic Authentication, Token Authentication
798
+
799
+ ### HTTP request headers
800
+
801
+ - **Content-Type**: application/json
802
+ - **Accept**: application/json
803
+
804
+
805
+ ## datacenters_servers_labels_put
806
+
807
+ > <LabelResource> datacenters_servers_labels_put(datacenter_id, server_id, key, label, opts)
808
+
809
+ Modify a Label of Server
810
+
811
+ This will modify the value of the label on a server.
812
+
813
+ ### Examples
814
+
815
+ ```ruby
816
+ require 'time'
817
+ require 'ionoscloud'
818
+ # setup authorization
819
+ Ionoscloud.configure do |config|
820
+ # Configure HTTP basic authorization: Basic Authentication
821
+ config.username = 'YOUR USERNAME'
822
+ config.password = 'YOUR PASSWORD'
823
+
824
+ # Configure API key authorization: Token Authentication
825
+ config.api_key['Authorization'] = 'YOUR API KEY'
826
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
827
+ # config.api_key_prefix['Authorization'] = 'Bearer'
828
+ end
829
+
830
+ api_instance = Ionoscloud::LabelsApi.new
831
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
832
+ server_id = 'server_id_example' # String | The unique ID of the Server
833
+ key = 'key_example' # String | The key of the Label
834
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
835
+ opts = {
836
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
837
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
838
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
839
+ }
840
+
841
+ begin
842
+ # Modify a Label of Server
843
+ result = api_instance.datacenters_servers_labels_put(datacenter_id, server_id, key, label, opts)
844
+ p result
845
+ rescue Ionoscloud::ApiError => e
846
+ puts "Error when calling LabelsApi->datacenters_servers_labels_put: #{e}"
847
+ end
848
+ ```
849
+
850
+ #### Using the datacenters_servers_labels_put_with_http_info variant
851
+
852
+ This returns an Array which contains the response data, status code and headers.
853
+
854
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_servers_labels_put_with_http_info(datacenter_id, server_id, key, label, opts)
855
+
856
+ ```ruby
857
+ begin
858
+ # Modify a Label of Server
859
+ data, status_code, headers = api_instance.datacenters_servers_labels_put_with_http_info(datacenter_id, server_id, key, label, opts)
860
+ p status_code # => 2xx
861
+ p headers # => { ... }
862
+ p data # => <LabelResource>
863
+ rescue Ionoscloud::ApiError => e
864
+ puts "Error when calling LabelsApi->datacenters_servers_labels_put_with_http_info: #{e}"
865
+ end
866
+ ```
867
+
868
+ ### Parameters
869
+
870
+ | Name | Type | Description | Notes |
871
+ | ---- | ---- | ----------- | ----- |
872
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
873
+ | **server_id** | **String** | The unique ID of the Server | |
874
+ | **key** | **String** | The key of the Label | |
875
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
876
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
877
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
878
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
879
+
880
+ ### Return type
881
+
882
+ [**LabelResource**](LabelResource.md)
883
+
884
+ ### Authorization
885
+
886
+ Basic Authentication, Token Authentication
887
+
888
+ ### HTTP request headers
889
+
890
+ - **Content-Type**: application/json
891
+ - **Accept**: application/json
892
+
893
+
894
+ ## datacenters_volumes_labels_delete
895
+
896
+ > datacenters_volumes_labels_delete(datacenter_id, volume_id, key, opts)
897
+
898
+ Delete a Label from Volume
899
+
900
+ This will remove a label from the volume.
901
+
902
+ ### Examples
903
+
904
+ ```ruby
905
+ require 'time'
906
+ require 'ionoscloud'
907
+ # setup authorization
908
+ Ionoscloud.configure do |config|
909
+ # Configure HTTP basic authorization: Basic Authentication
910
+ config.username = 'YOUR USERNAME'
911
+ config.password = 'YOUR PASSWORD'
912
+
913
+ # Configure API key authorization: Token Authentication
914
+ config.api_key['Authorization'] = 'YOUR API KEY'
915
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
916
+ # config.api_key_prefix['Authorization'] = 'Bearer'
917
+ end
918
+
919
+ api_instance = Ionoscloud::LabelsApi.new
920
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
921
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
922
+ key = 'key_example' # String | The key of the Label
923
+ opts = {
924
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
925
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
926
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
927
+ }
928
+
929
+ begin
930
+ # Delete a Label from Volume
931
+ api_instance.datacenters_volumes_labels_delete(datacenter_id, volume_id, key, opts)
932
+ rescue Ionoscloud::ApiError => e
933
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_delete: #{e}"
934
+ end
935
+ ```
936
+
937
+ #### Using the datacenters_volumes_labels_delete_with_http_info variant
938
+
939
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
940
+
941
+ > <Array(nil, Integer, Hash)> datacenters_volumes_labels_delete_with_http_info(datacenter_id, volume_id, key, opts)
942
+
943
+ ```ruby
944
+ begin
945
+ # Delete a Label from Volume
946
+ data, status_code, headers = api_instance.datacenters_volumes_labels_delete_with_http_info(datacenter_id, volume_id, key, opts)
947
+ p status_code # => 2xx
948
+ p headers # => { ... }
949
+ p data # => nil
950
+ rescue Ionoscloud::ApiError => e
951
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_delete_with_http_info: #{e}"
952
+ end
953
+ ```
954
+
955
+ ### Parameters
956
+
957
+ | Name | Type | Description | Notes |
958
+ | ---- | ---- | ----------- | ----- |
959
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
960
+ | **volume_id** | **String** | The unique ID of the Volume | |
961
+ | **key** | **String** | The key of the Label | |
962
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
963
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
964
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
965
+
966
+ ### Return type
967
+
968
+ nil (empty response body)
969
+
970
+ ### Authorization
971
+
972
+ Basic Authentication, Token Authentication
973
+
974
+ ### HTTP request headers
975
+
976
+ - **Content-Type**: Not defined
977
+ - **Accept**: application/json
978
+
979
+
980
+ ## datacenters_volumes_labels_find_by_key
981
+
982
+ > <LabelResource> datacenters_volumes_labels_find_by_key(datacenter_id, volume_id, key, opts)
983
+
984
+ Retrieve a Label of Volume
985
+
986
+ This will retrieve the properties of a associated label to a volume.
987
+
988
+ ### Examples
989
+
990
+ ```ruby
991
+ require 'time'
992
+ require 'ionoscloud'
993
+ # setup authorization
994
+ Ionoscloud.configure do |config|
995
+ # Configure HTTP basic authorization: Basic Authentication
996
+ config.username = 'YOUR USERNAME'
997
+ config.password = 'YOUR PASSWORD'
998
+
999
+ # Configure API key authorization: Token Authentication
1000
+ config.api_key['Authorization'] = 'YOUR API KEY'
1001
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1002
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1003
+ end
1004
+
1005
+ api_instance = Ionoscloud::LabelsApi.new
1006
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
1007
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
1008
+ key = 'key_example' # String | The key of the Label
1009
+ opts = {
1010
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1011
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1012
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1013
+ }
1014
+
1015
+ begin
1016
+ # Retrieve a Label of Volume
1017
+ result = api_instance.datacenters_volumes_labels_find_by_key(datacenter_id, volume_id, key, opts)
1018
+ p result
1019
+ rescue Ionoscloud::ApiError => e
1020
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_find_by_key: #{e}"
1021
+ end
1022
+ ```
1023
+
1024
+ #### Using the datacenters_volumes_labels_find_by_key_with_http_info variant
1025
+
1026
+ This returns an Array which contains the response data, status code and headers.
1027
+
1028
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_volumes_labels_find_by_key_with_http_info(datacenter_id, volume_id, key, opts)
1029
+
1030
+ ```ruby
1031
+ begin
1032
+ # Retrieve a Label of Volume
1033
+ data, status_code, headers = api_instance.datacenters_volumes_labels_find_by_key_with_http_info(datacenter_id, volume_id, key, opts)
1034
+ p status_code # => 2xx
1035
+ p headers # => { ... }
1036
+ p data # => <LabelResource>
1037
+ rescue Ionoscloud::ApiError => e
1038
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_find_by_key_with_http_info: #{e}"
1039
+ end
1040
+ ```
1041
+
1042
+ ### Parameters
1043
+
1044
+ | Name | Type | Description | Notes |
1045
+ | ---- | ---- | ----------- | ----- |
1046
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
1047
+ | **volume_id** | **String** | The unique ID of the Volume | |
1048
+ | **key** | **String** | The key of the Label | |
1049
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1050
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1051
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1052
+
1053
+ ### Return type
1054
+
1055
+ [**LabelResource**](LabelResource.md)
1056
+
1057
+ ### Authorization
1058
+
1059
+ Basic Authentication, Token Authentication
1060
+
1061
+ ### HTTP request headers
1062
+
1063
+ - **Content-Type**: Not defined
1064
+ - **Accept**: application/json
1065
+
1066
+
1067
+ ## datacenters_volumes_labels_get
1068
+
1069
+ > <LabelResources> datacenters_volumes_labels_get(datacenter_id, volume_id, opts)
1070
+
1071
+ List all Volume Labels
1072
+
1073
+ You can retrieve a list of all labels associated with a volume.
1074
+
1075
+ ### Examples
1076
+
1077
+ ```ruby
1078
+ require 'time'
1079
+ require 'ionoscloud'
1080
+ # setup authorization
1081
+ Ionoscloud.configure do |config|
1082
+ # Configure HTTP basic authorization: Basic Authentication
1083
+ config.username = 'YOUR USERNAME'
1084
+ config.password = 'YOUR PASSWORD'
1085
+
1086
+ # Configure API key authorization: Token Authentication
1087
+ config.api_key['Authorization'] = 'YOUR API KEY'
1088
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1089
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1090
+ end
1091
+
1092
+ api_instance = Ionoscloud::LabelsApi.new
1093
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
1094
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
1095
+ opts = {
1096
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1097
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1098
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1099
+ }
1100
+
1101
+ begin
1102
+ # List all Volume Labels
1103
+ result = api_instance.datacenters_volumes_labels_get(datacenter_id, volume_id, opts)
1104
+ p result
1105
+ rescue Ionoscloud::ApiError => e
1106
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_get: #{e}"
1107
+ end
1108
+ ```
1109
+
1110
+ #### Using the datacenters_volumes_labels_get_with_http_info variant
1111
+
1112
+ This returns an Array which contains the response data, status code and headers.
1113
+
1114
+ > <Array(<LabelResources>, Integer, Hash)> datacenters_volumes_labels_get_with_http_info(datacenter_id, volume_id, opts)
1115
+
1116
+ ```ruby
1117
+ begin
1118
+ # List all Volume Labels
1119
+ data, status_code, headers = api_instance.datacenters_volumes_labels_get_with_http_info(datacenter_id, volume_id, opts)
1120
+ p status_code # => 2xx
1121
+ p headers # => { ... }
1122
+ p data # => <LabelResources>
1123
+ rescue Ionoscloud::ApiError => e
1124
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_get_with_http_info: #{e}"
1125
+ end
1126
+ ```
1127
+
1128
+ ### Parameters
1129
+
1130
+ | Name | Type | Description | Notes |
1131
+ | ---- | ---- | ----------- | ----- |
1132
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
1133
+ | **volume_id** | **String** | The unique ID of the Volume | |
1134
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1135
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1136
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1137
+
1138
+ ### Return type
1139
+
1140
+ [**LabelResources**](LabelResources.md)
1141
+
1142
+ ### Authorization
1143
+
1144
+ Basic Authentication, Token Authentication
1145
+
1146
+ ### HTTP request headers
1147
+
1148
+ - **Content-Type**: Not defined
1149
+ - **Accept**: application/json
1150
+
1151
+
1152
+ ## datacenters_volumes_labels_post
1153
+
1154
+ > <LabelResource> datacenters_volumes_labels_post(datacenter_id, volume_id, label, opts)
1155
+
1156
+ Add a Label to Volume
1157
+
1158
+ This will add a label to the volume.
1159
+
1160
+ ### Examples
1161
+
1162
+ ```ruby
1163
+ require 'time'
1164
+ require 'ionoscloud'
1165
+ # setup authorization
1166
+ Ionoscloud.configure do |config|
1167
+ # Configure HTTP basic authorization: Basic Authentication
1168
+ config.username = 'YOUR USERNAME'
1169
+ config.password = 'YOUR PASSWORD'
1170
+
1171
+ # Configure API key authorization: Token Authentication
1172
+ config.api_key['Authorization'] = 'YOUR API KEY'
1173
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1174
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1175
+ end
1176
+
1177
+ api_instance = Ionoscloud::LabelsApi.new
1178
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
1179
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
1180
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
1181
+ opts = {
1182
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1183
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1184
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1185
+ }
1186
+
1187
+ begin
1188
+ # Add a Label to Volume
1189
+ result = api_instance.datacenters_volumes_labels_post(datacenter_id, volume_id, label, opts)
1190
+ p result
1191
+ rescue Ionoscloud::ApiError => e
1192
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_post: #{e}"
1193
+ end
1194
+ ```
1195
+
1196
+ #### Using the datacenters_volumes_labels_post_with_http_info variant
1197
+
1198
+ This returns an Array which contains the response data, status code and headers.
1199
+
1200
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_volumes_labels_post_with_http_info(datacenter_id, volume_id, label, opts)
1201
+
1202
+ ```ruby
1203
+ begin
1204
+ # Add a Label to Volume
1205
+ data, status_code, headers = api_instance.datacenters_volumes_labels_post_with_http_info(datacenter_id, volume_id, label, opts)
1206
+ p status_code # => 2xx
1207
+ p headers # => { ... }
1208
+ p data # => <LabelResource>
1209
+ rescue Ionoscloud::ApiError => e
1210
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_post_with_http_info: #{e}"
1211
+ end
1212
+ ```
1213
+
1214
+ ### Parameters
1215
+
1216
+ | Name | Type | Description | Notes |
1217
+ | ---- | ---- | ----------- | ----- |
1218
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
1219
+ | **volume_id** | **String** | The unique ID of the Volume | |
1220
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
1221
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1222
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1224
+
1225
+ ### Return type
1226
+
1227
+ [**LabelResource**](LabelResource.md)
1228
+
1229
+ ### Authorization
1230
+
1231
+ Basic Authentication, Token Authentication
1232
+
1233
+ ### HTTP request headers
1234
+
1235
+ - **Content-Type**: application/json
1236
+ - **Accept**: application/json
1237
+
1238
+
1239
+ ## datacenters_volumes_labels_put
1240
+
1241
+ > <LabelResource> datacenters_volumes_labels_put(datacenter_id, volume_id, key, label, opts)
1242
+
1243
+ Modify a Label of Volume
1244
+
1245
+ This will modify the value of the label on a volume.
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::LabelsApi.new
1265
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
1266
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
1267
+ key = 'key_example' # String | The key of the Label
1268
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
1269
+ opts = {
1270
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1271
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1272
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1273
+ }
1274
+
1275
+ begin
1276
+ # Modify a Label of Volume
1277
+ result = api_instance.datacenters_volumes_labels_put(datacenter_id, volume_id, key, label, opts)
1278
+ p result
1279
+ rescue Ionoscloud::ApiError => e
1280
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_put: #{e}"
1281
+ end
1282
+ ```
1283
+
1284
+ #### Using the datacenters_volumes_labels_put_with_http_info variant
1285
+
1286
+ This returns an Array which contains the response data, status code and headers.
1287
+
1288
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_volumes_labels_put_with_http_info(datacenter_id, volume_id, key, label, opts)
1289
+
1290
+ ```ruby
1291
+ begin
1292
+ # Modify a Label of Volume
1293
+ data, status_code, headers = api_instance.datacenters_volumes_labels_put_with_http_info(datacenter_id, volume_id, key, label, opts)
1294
+ p status_code # => 2xx
1295
+ p headers # => { ... }
1296
+ p data # => <LabelResource>
1297
+ rescue Ionoscloud::ApiError => e
1298
+ puts "Error when calling LabelsApi->datacenters_volumes_labels_put_with_http_info: #{e}"
1299
+ end
1300
+ ```
1301
+
1302
+ ### Parameters
1303
+
1304
+ | Name | Type | Description | Notes |
1305
+ | ---- | ---- | ----------- | ----- |
1306
+ | **datacenter_id** | **String** | The unique ID of the data center. | |
1307
+ | **volume_id** | **String** | The unique ID of the Volume | |
1308
+ | **key** | **String** | The key of the Label | |
1309
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
1310
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1311
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1312
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1313
+
1314
+ ### Return type
1315
+
1316
+ [**LabelResource**](LabelResource.md)
1317
+
1318
+ ### Authorization
1319
+
1320
+ Basic Authentication, Token Authentication
1321
+
1322
+ ### HTTP request headers
1323
+
1324
+ - **Content-Type**: application/json
1325
+ - **Accept**: application/json
1326
+
1327
+
1328
+ ## ipblocks_labels_delete
1329
+
1330
+ > ipblocks_labels_delete(ipblock_id, key, opts)
1331
+
1332
+ Delete a Label from IP Block
1333
+
1334
+ This will remove a label from the Ip Block.
1335
+
1336
+ ### Examples
1337
+
1338
+ ```ruby
1339
+ require 'time'
1340
+ require 'ionoscloud'
1341
+ # setup authorization
1342
+ Ionoscloud.configure do |config|
1343
+ # Configure HTTP basic authorization: Basic Authentication
1344
+ config.username = 'YOUR USERNAME'
1345
+ config.password = 'YOUR PASSWORD'
1346
+
1347
+ # Configure API key authorization: Token Authentication
1348
+ config.api_key['Authorization'] = 'YOUR API KEY'
1349
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1350
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1351
+ end
1352
+
1353
+ api_instance = Ionoscloud::LabelsApi.new
1354
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1355
+ key = 'key_example' # String | The key of the Label
1356
+ opts = {
1357
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1358
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1359
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1360
+ }
1361
+
1362
+ begin
1363
+ # Delete a Label from IP Block
1364
+ api_instance.ipblocks_labels_delete(ipblock_id, key, opts)
1365
+ rescue Ionoscloud::ApiError => e
1366
+ puts "Error when calling LabelsApi->ipblocks_labels_delete: #{e}"
1367
+ end
1368
+ ```
1369
+
1370
+ #### Using the ipblocks_labels_delete_with_http_info variant
1371
+
1372
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1373
+
1374
+ > <Array(nil, Integer, Hash)> ipblocks_labels_delete_with_http_info(ipblock_id, key, opts)
1375
+
1376
+ ```ruby
1377
+ begin
1378
+ # Delete a Label from IP Block
1379
+ data, status_code, headers = api_instance.ipblocks_labels_delete_with_http_info(ipblock_id, key, opts)
1380
+ p status_code # => 2xx
1381
+ p headers # => { ... }
1382
+ p data # => nil
1383
+ rescue Ionoscloud::ApiError => e
1384
+ puts "Error when calling LabelsApi->ipblocks_labels_delete_with_http_info: #{e}"
1385
+ end
1386
+ ```
1387
+
1388
+ ### Parameters
1389
+
1390
+ | Name | Type | Description | Notes |
1391
+ | ---- | ---- | ----------- | ----- |
1392
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1393
+ | **key** | **String** | The key of the Label | |
1394
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1395
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1396
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1397
+
1398
+ ### Return type
1399
+
1400
+ nil (empty response body)
1401
+
1402
+ ### Authorization
1403
+
1404
+ Basic Authentication, Token Authentication
1405
+
1406
+ ### HTTP request headers
1407
+
1408
+ - **Content-Type**: Not defined
1409
+ - **Accept**: application/json
1410
+
1411
+
1412
+ ## ipblocks_labels_find_by_key
1413
+
1414
+ > <LabelResource> ipblocks_labels_find_by_key(ipblock_id, key, opts)
1415
+
1416
+ Retrieve a Label of IP Block
1417
+
1418
+ This will retrieve the properties of a associated label to a Ip Block.
1419
+
1420
+ ### Examples
1421
+
1422
+ ```ruby
1423
+ require 'time'
1424
+ require 'ionoscloud'
1425
+ # setup authorization
1426
+ Ionoscloud.configure do |config|
1427
+ # Configure HTTP basic authorization: Basic Authentication
1428
+ config.username = 'YOUR USERNAME'
1429
+ config.password = 'YOUR PASSWORD'
1430
+
1431
+ # Configure API key authorization: Token Authentication
1432
+ config.api_key['Authorization'] = 'YOUR API KEY'
1433
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1434
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1435
+ end
1436
+
1437
+ api_instance = Ionoscloud::LabelsApi.new
1438
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1439
+ key = 'key_example' # String | The key of the Label
1440
+ opts = {
1441
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1442
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1443
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1444
+ }
1445
+
1446
+ begin
1447
+ # Retrieve a Label of IP Block
1448
+ result = api_instance.ipblocks_labels_find_by_key(ipblock_id, key, opts)
1449
+ p result
1450
+ rescue Ionoscloud::ApiError => e
1451
+ puts "Error when calling LabelsApi->ipblocks_labels_find_by_key: #{e}"
1452
+ end
1453
+ ```
1454
+
1455
+ #### Using the ipblocks_labels_find_by_key_with_http_info variant
1456
+
1457
+ This returns an Array which contains the response data, status code and headers.
1458
+
1459
+ > <Array(<LabelResource>, Integer, Hash)> ipblocks_labels_find_by_key_with_http_info(ipblock_id, key, opts)
1460
+
1461
+ ```ruby
1462
+ begin
1463
+ # Retrieve a Label of IP Block
1464
+ data, status_code, headers = api_instance.ipblocks_labels_find_by_key_with_http_info(ipblock_id, key, opts)
1465
+ p status_code # => 2xx
1466
+ p headers # => { ... }
1467
+ p data # => <LabelResource>
1468
+ rescue Ionoscloud::ApiError => e
1469
+ puts "Error when calling LabelsApi->ipblocks_labels_find_by_key_with_http_info: #{e}"
1470
+ end
1471
+ ```
1472
+
1473
+ ### Parameters
1474
+
1475
+ | Name | Type | Description | Notes |
1476
+ | ---- | ---- | ----------- | ----- |
1477
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1478
+ | **key** | **String** | The key of the Label | |
1479
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1480
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1481
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1482
+
1483
+ ### Return type
1484
+
1485
+ [**LabelResource**](LabelResource.md)
1486
+
1487
+ ### Authorization
1488
+
1489
+ Basic Authentication, Token Authentication
1490
+
1491
+ ### HTTP request headers
1492
+
1493
+ - **Content-Type**: Not defined
1494
+ - **Accept**: application/json
1495
+
1496
+
1497
+ ## ipblocks_labels_get
1498
+
1499
+ > <LabelResources> ipblocks_labels_get(ipblock_id, opts)
1500
+
1501
+ List all Ip Block Labels
1502
+
1503
+ You can retrieve a list of all labels associated with a IP Block.
1504
+
1505
+ ### Examples
1506
+
1507
+ ```ruby
1508
+ require 'time'
1509
+ require 'ionoscloud'
1510
+ # setup authorization
1511
+ Ionoscloud.configure do |config|
1512
+ # Configure HTTP basic authorization: Basic Authentication
1513
+ config.username = 'YOUR USERNAME'
1514
+ config.password = 'YOUR PASSWORD'
1515
+
1516
+ # Configure API key authorization: Token Authentication
1517
+ config.api_key['Authorization'] = 'YOUR API KEY'
1518
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1519
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1520
+ end
1521
+
1522
+ api_instance = Ionoscloud::LabelsApi.new
1523
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1524
+ opts = {
1525
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1526
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1527
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1528
+ }
1529
+
1530
+ begin
1531
+ # List all Ip Block Labels
1532
+ result = api_instance.ipblocks_labels_get(ipblock_id, opts)
1533
+ p result
1534
+ rescue Ionoscloud::ApiError => e
1535
+ puts "Error when calling LabelsApi->ipblocks_labels_get: #{e}"
1536
+ end
1537
+ ```
1538
+
1539
+ #### Using the ipblocks_labels_get_with_http_info variant
1540
+
1541
+ This returns an Array which contains the response data, status code and headers.
1542
+
1543
+ > <Array(<LabelResources>, Integer, Hash)> ipblocks_labels_get_with_http_info(ipblock_id, opts)
1544
+
1545
+ ```ruby
1546
+ begin
1547
+ # List all Ip Block Labels
1548
+ data, status_code, headers = api_instance.ipblocks_labels_get_with_http_info(ipblock_id, opts)
1549
+ p status_code # => 2xx
1550
+ p headers # => { ... }
1551
+ p data # => <LabelResources>
1552
+ rescue Ionoscloud::ApiError => e
1553
+ puts "Error when calling LabelsApi->ipblocks_labels_get_with_http_info: #{e}"
1554
+ end
1555
+ ```
1556
+
1557
+ ### Parameters
1558
+
1559
+ | Name | Type | Description | Notes |
1560
+ | ---- | ---- | ----------- | ----- |
1561
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1562
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1563
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1564
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1565
+
1566
+ ### Return type
1567
+
1568
+ [**LabelResources**](LabelResources.md)
1569
+
1570
+ ### Authorization
1571
+
1572
+ Basic Authentication, Token Authentication
1573
+
1574
+ ### HTTP request headers
1575
+
1576
+ - **Content-Type**: Not defined
1577
+ - **Accept**: application/json
1578
+
1579
+
1580
+ ## ipblocks_labels_post
1581
+
1582
+ > <LabelResource> ipblocks_labels_post(ipblock_id, label, opts)
1583
+
1584
+ Add a Label to IP Block
1585
+
1586
+ This will add a label to the Ip Block.
1587
+
1588
+ ### Examples
1589
+
1590
+ ```ruby
1591
+ require 'time'
1592
+ require 'ionoscloud'
1593
+ # setup authorization
1594
+ Ionoscloud.configure do |config|
1595
+ # Configure HTTP basic authorization: Basic Authentication
1596
+ config.username = 'YOUR USERNAME'
1597
+ config.password = 'YOUR PASSWORD'
1598
+
1599
+ # Configure API key authorization: Token Authentication
1600
+ config.api_key['Authorization'] = 'YOUR API KEY'
1601
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1602
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1603
+ end
1604
+
1605
+ api_instance = Ionoscloud::LabelsApi.new
1606
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1607
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
1608
+ opts = {
1609
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1610
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed.
1612
+ }
1613
+
1614
+ begin
1615
+ # Add a Label to IP Block
1616
+ result = api_instance.ipblocks_labels_post(ipblock_id, label, opts)
1617
+ p result
1618
+ rescue Ionoscloud::ApiError => e
1619
+ puts "Error when calling LabelsApi->ipblocks_labels_post: #{e}"
1620
+ end
1621
+ ```
1622
+
1623
+ #### Using the ipblocks_labels_post_with_http_info variant
1624
+
1625
+ This returns an Array which contains the response data, status code and headers.
1626
+
1627
+ > <Array(<LabelResource>, Integer, Hash)> ipblocks_labels_post_with_http_info(ipblock_id, label, opts)
1628
+
1629
+ ```ruby
1630
+ begin
1631
+ # Add a Label to IP Block
1632
+ data, status_code, headers = api_instance.ipblocks_labels_post_with_http_info(ipblock_id, label, opts)
1633
+ p status_code # => 2xx
1634
+ p headers # => { ... }
1635
+ p data # => <LabelResource>
1636
+ rescue Ionoscloud::ApiError => e
1637
+ puts "Error when calling LabelsApi->ipblocks_labels_post_with_http_info: #{e}"
1638
+ end
1639
+ ```
1640
+
1641
+ ### Parameters
1642
+
1643
+ | Name | Type | Description | Notes |
1644
+ | ---- | ---- | ----------- | ----- |
1645
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1646
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
1647
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1648
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1649
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1650
+
1651
+ ### Return type
1652
+
1653
+ [**LabelResource**](LabelResource.md)
1654
+
1655
+ ### Authorization
1656
+
1657
+ Basic Authentication, Token Authentication
1658
+
1659
+ ### HTTP request headers
1660
+
1661
+ - **Content-Type**: application/json
1662
+ - **Accept**: application/json
1663
+
1664
+
1665
+ ## ipblocks_labels_put
1666
+
1667
+ > <LabelResource> ipblocks_labels_put(ipblock_id, key, label, opts)
1668
+
1669
+ Modify a Label of IP Block
1670
+
1671
+ This will modify the value of the label on a Ip Block.
1672
+
1673
+ ### Examples
1674
+
1675
+ ```ruby
1676
+ require 'time'
1677
+ require 'ionoscloud'
1678
+ # setup authorization
1679
+ Ionoscloud.configure do |config|
1680
+ # Configure HTTP basic authorization: Basic Authentication
1681
+ config.username = 'YOUR USERNAME'
1682
+ config.password = 'YOUR PASSWORD'
1683
+
1684
+ # Configure API key authorization: Token Authentication
1685
+ config.api_key['Authorization'] = 'YOUR API KEY'
1686
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1687
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1688
+ end
1689
+
1690
+ api_instance = Ionoscloud::LabelsApi.new
1691
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1692
+ key = 'key_example' # String | The key of the Label
1693
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
1694
+ opts = {
1695
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1696
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1697
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1698
+ }
1699
+
1700
+ begin
1701
+ # Modify a Label of IP Block
1702
+ result = api_instance.ipblocks_labels_put(ipblock_id, key, label, opts)
1703
+ p result
1704
+ rescue Ionoscloud::ApiError => e
1705
+ puts "Error when calling LabelsApi->ipblocks_labels_put: #{e}"
1706
+ end
1707
+ ```
1708
+
1709
+ #### Using the ipblocks_labels_put_with_http_info variant
1710
+
1711
+ This returns an Array which contains the response data, status code and headers.
1712
+
1713
+ > <Array(<LabelResource>, Integer, Hash)> ipblocks_labels_put_with_http_info(ipblock_id, key, label, opts)
1714
+
1715
+ ```ruby
1716
+ begin
1717
+ # Modify a Label of IP Block
1718
+ data, status_code, headers = api_instance.ipblocks_labels_put_with_http_info(ipblock_id, key, label, opts)
1719
+ p status_code # => 2xx
1720
+ p headers # => { ... }
1721
+ p data # => <LabelResource>
1722
+ rescue Ionoscloud::ApiError => e
1723
+ puts "Error when calling LabelsApi->ipblocks_labels_put_with_http_info: #{e}"
1724
+ end
1725
+ ```
1726
+
1727
+ ### Parameters
1728
+
1729
+ | Name | Type | Description | Notes |
1730
+ | ---- | ---- | ----------- | ----- |
1731
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1732
+ | **key** | **String** | The key of the Label | |
1733
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
1734
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1735
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1736
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1737
+
1738
+ ### Return type
1739
+
1740
+ [**LabelResource**](LabelResource.md)
1741
+
1742
+ ### Authorization
1743
+
1744
+ Basic Authentication, Token Authentication
1745
+
1746
+ ### HTTP request headers
1747
+
1748
+ - **Content-Type**: application/json
1749
+ - **Accept**: application/json
1750
+
1751
+
1752
+ ## labels_find_by_urn
1753
+
1754
+ > <Label> labels_find_by_urn(labelurn, opts)
1755
+
1756
+ Returns the label by its URN.
1757
+
1758
+ You can retrieve the details of a specific label using its URN. A URN is for uniqueness of a Label and composed using urn:label:<resource_type>:<resource_uuid>:<key>
1759
+
1760
+ ### Examples
1761
+
1762
+ ```ruby
1763
+ require 'time'
1764
+ require 'ionoscloud'
1765
+ # setup authorization
1766
+ Ionoscloud.configure do |config|
1767
+ # Configure HTTP basic authorization: Basic Authentication
1768
+ config.username = 'YOUR USERNAME'
1769
+ config.password = 'YOUR PASSWORD'
1770
+
1771
+ # Configure API key authorization: Token Authentication
1772
+ config.api_key['Authorization'] = 'YOUR API KEY'
1773
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1774
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1775
+ end
1776
+
1777
+ api_instance = Ionoscloud::LabelsApi.new
1778
+ labelurn = 'labelurn_example' # String | The URN representing the unique ID of the label. A URN is for uniqueness of a Label and composed using urn:label:<resource_type>:<resource_uuid>:<key>
1779
+ opts = {
1780
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1781
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1782
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1783
+ }
1784
+
1785
+ begin
1786
+ # Returns the label by its URN.
1787
+ result = api_instance.labels_find_by_urn(labelurn, opts)
1788
+ p result
1789
+ rescue Ionoscloud::ApiError => e
1790
+ puts "Error when calling LabelsApi->labels_find_by_urn: #{e}"
1791
+ end
1792
+ ```
1793
+
1794
+ #### Using the labels_find_by_urn_with_http_info variant
1795
+
1796
+ This returns an Array which contains the response data, status code and headers.
1797
+
1798
+ > <Array(<Label>, Integer, Hash)> labels_find_by_urn_with_http_info(labelurn, opts)
1799
+
1800
+ ```ruby
1801
+ begin
1802
+ # Returns the label by its URN.
1803
+ data, status_code, headers = api_instance.labels_find_by_urn_with_http_info(labelurn, opts)
1804
+ p status_code # => 2xx
1805
+ p headers # => { ... }
1806
+ p data # => <Label>
1807
+ rescue Ionoscloud::ApiError => e
1808
+ puts "Error when calling LabelsApi->labels_find_by_urn_with_http_info: #{e}"
1809
+ end
1810
+ ```
1811
+
1812
+ ### Parameters
1813
+
1814
+ | Name | Type | Description | Notes |
1815
+ | ---- | ---- | ----------- | ----- |
1816
+ | **labelurn** | **String** | The URN representing the unique ID of the label. A URN is for uniqueness of a Label and composed using urn:label:&lt;resource_type&gt;:&lt;resource_uuid&gt;:&lt;key&gt; | |
1817
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1818
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1820
+
1821
+ ### Return type
1822
+
1823
+ [**Label**](Label.md)
1824
+
1825
+ ### Authorization
1826
+
1827
+ Basic Authentication, Token Authentication
1828
+
1829
+ ### HTTP request headers
1830
+
1831
+ - **Content-Type**: Not defined
1832
+ - **Accept**: application/json
1833
+
1834
+
1835
+ ## labels_get
1836
+
1837
+ > <Labels> labels_get(opts)
1838
+
1839
+ List Labels
1840
+
1841
+ You can retrieve a complete list of labels that you have access to.
1842
+
1843
+ ### Examples
1844
+
1845
+ ```ruby
1846
+ require 'time'
1847
+ require 'ionoscloud'
1848
+ # setup authorization
1849
+ Ionoscloud.configure do |config|
1850
+ # Configure HTTP basic authorization: Basic Authentication
1851
+ config.username = 'YOUR USERNAME'
1852
+ config.password = 'YOUR PASSWORD'
1853
+
1854
+ # Configure API key authorization: Token Authentication
1855
+ config.api_key['Authorization'] = 'YOUR API KEY'
1856
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1857
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1858
+ end
1859
+
1860
+ api_instance = Ionoscloud::LabelsApi.new
1861
+ opts = {
1862
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1863
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed.
1865
+ }
1866
+
1867
+ begin
1868
+ # List Labels
1869
+ result = api_instance.labels_get(opts)
1870
+ p result
1871
+ rescue Ionoscloud::ApiError => e
1872
+ puts "Error when calling LabelsApi->labels_get: #{e}"
1873
+ end
1874
+ ```
1875
+
1876
+ #### Using the labels_get_with_http_info variant
1877
+
1878
+ This returns an Array which contains the response data, status code and headers.
1879
+
1880
+ > <Array(<Labels>, Integer, Hash)> labels_get_with_http_info(opts)
1881
+
1882
+ ```ruby
1883
+ begin
1884
+ # List Labels
1885
+ data, status_code, headers = api_instance.labels_get_with_http_info(opts)
1886
+ p status_code # => 2xx
1887
+ p headers # => { ... }
1888
+ p data # => <Labels>
1889
+ rescue Ionoscloud::ApiError => e
1890
+ puts "Error when calling LabelsApi->labels_get_with_http_info: #{e}"
1891
+ end
1892
+ ```
1893
+
1894
+ ### Parameters
1895
+
1896
+ | Name | Type | Description | Notes |
1897
+ | ---- | ---- | ----------- | ----- |
1898
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1899
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1900
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1901
+
1902
+ ### Return type
1903
+
1904
+ [**Labels**](Labels.md)
1905
+
1906
+ ### Authorization
1907
+
1908
+ Basic Authentication, Token Authentication
1909
+
1910
+ ### HTTP request headers
1911
+
1912
+ - **Content-Type**: Not defined
1913
+ - **Accept**: application/json
1914
+
1915
+
1916
+ ## snapshots_labels_delete
1917
+
1918
+ > snapshots_labels_delete(snapshot_id, key, opts)
1919
+
1920
+ Delete a Label from Snapshot
1921
+
1922
+ This will remove a label from the snapshot.
1923
+
1924
+ ### Examples
1925
+
1926
+ ```ruby
1927
+ require 'time'
1928
+ require 'ionoscloud'
1929
+ # setup authorization
1930
+ Ionoscloud.configure do |config|
1931
+ # Configure HTTP basic authorization: Basic Authentication
1932
+ config.username = 'YOUR USERNAME'
1933
+ config.password = 'YOUR PASSWORD'
1934
+
1935
+ # Configure API key authorization: Token Authentication
1936
+ config.api_key['Authorization'] = 'YOUR API KEY'
1937
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1938
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1939
+ end
1940
+
1941
+ api_instance = Ionoscloud::LabelsApi.new
1942
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
1943
+ key = 'key_example' # String | The key of the Label
1944
+ opts = {
1945
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1946
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1947
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1948
+ }
1949
+
1950
+ begin
1951
+ # Delete a Label from Snapshot
1952
+ api_instance.snapshots_labels_delete(snapshot_id, key, opts)
1953
+ rescue Ionoscloud::ApiError => e
1954
+ puts "Error when calling LabelsApi->snapshots_labels_delete: #{e}"
1955
+ end
1956
+ ```
1957
+
1958
+ #### Using the snapshots_labels_delete_with_http_info variant
1959
+
1960
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1961
+
1962
+ > <Array(nil, Integer, Hash)> snapshots_labels_delete_with_http_info(snapshot_id, key, opts)
1963
+
1964
+ ```ruby
1965
+ begin
1966
+ # Delete a Label from Snapshot
1967
+ data, status_code, headers = api_instance.snapshots_labels_delete_with_http_info(snapshot_id, key, opts)
1968
+ p status_code # => 2xx
1969
+ p headers # => { ... }
1970
+ p data # => nil
1971
+ rescue Ionoscloud::ApiError => e
1972
+ puts "Error when calling LabelsApi->snapshots_labels_delete_with_http_info: #{e}"
1973
+ end
1974
+ ```
1975
+
1976
+ ### Parameters
1977
+
1978
+ | Name | Type | Description | Notes |
1979
+ | ---- | ---- | ----------- | ----- |
1980
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
1981
+ | **key** | **String** | The key of the Label | |
1982
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1983
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1984
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1985
+
1986
+ ### Return type
1987
+
1988
+ nil (empty response body)
1989
+
1990
+ ### Authorization
1991
+
1992
+ Basic Authentication, Token Authentication
1993
+
1994
+ ### HTTP request headers
1995
+
1996
+ - **Content-Type**: Not defined
1997
+ - **Accept**: application/json
1998
+
1999
+
2000
+ ## snapshots_labels_find_by_key
2001
+
2002
+ > <LabelResource> snapshots_labels_find_by_key(snapshot_id, key, opts)
2003
+
2004
+ Retrieve a Label of Snapshot
2005
+
2006
+ This will retrieve the properties of a associated label to a snapshot.
2007
+
2008
+ ### Examples
2009
+
2010
+ ```ruby
2011
+ require 'time'
2012
+ require 'ionoscloud'
2013
+ # setup authorization
2014
+ Ionoscloud.configure do |config|
2015
+ # Configure HTTP basic authorization: Basic Authentication
2016
+ config.username = 'YOUR USERNAME'
2017
+ config.password = 'YOUR PASSWORD'
2018
+
2019
+ # Configure API key authorization: Token Authentication
2020
+ config.api_key['Authorization'] = 'YOUR API KEY'
2021
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2022
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2023
+ end
2024
+
2025
+ api_instance = Ionoscloud::LabelsApi.new
2026
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
2027
+ key = 'key_example' # String | The key of the Label
2028
+ opts = {
2029
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
2030
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
2031
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
2032
+ }
2033
+
2034
+ begin
2035
+ # Retrieve a Label of Snapshot
2036
+ result = api_instance.snapshots_labels_find_by_key(snapshot_id, key, opts)
2037
+ p result
2038
+ rescue Ionoscloud::ApiError => e
2039
+ puts "Error when calling LabelsApi->snapshots_labels_find_by_key: #{e}"
2040
+ end
2041
+ ```
2042
+
2043
+ #### Using the snapshots_labels_find_by_key_with_http_info variant
2044
+
2045
+ This returns an Array which contains the response data, status code and headers.
2046
+
2047
+ > <Array(<LabelResource>, Integer, Hash)> snapshots_labels_find_by_key_with_http_info(snapshot_id, key, opts)
2048
+
2049
+ ```ruby
2050
+ begin
2051
+ # Retrieve a Label of Snapshot
2052
+ data, status_code, headers = api_instance.snapshots_labels_find_by_key_with_http_info(snapshot_id, key, opts)
2053
+ p status_code # => 2xx
2054
+ p headers # => { ... }
2055
+ p data # => <LabelResource>
2056
+ rescue Ionoscloud::ApiError => e
2057
+ puts "Error when calling LabelsApi->snapshots_labels_find_by_key_with_http_info: #{e}"
2058
+ end
2059
+ ```
2060
+
2061
+ ### Parameters
2062
+
2063
+ | Name | Type | Description | Notes |
2064
+ | ---- | ---- | ----------- | ----- |
2065
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
2066
+ | **key** | **String** | The key of the Label | |
2067
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
2068
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
2069
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
2070
+
2071
+ ### Return type
2072
+
2073
+ [**LabelResource**](LabelResource.md)
2074
+
2075
+ ### Authorization
2076
+
2077
+ Basic Authentication, Token Authentication
2078
+
2079
+ ### HTTP request headers
2080
+
2081
+ - **Content-Type**: Not defined
2082
+ - **Accept**: application/json
2083
+
2084
+
2085
+ ## snapshots_labels_get
2086
+
2087
+ > <LabelResources> snapshots_labels_get(snapshot_id, opts)
2088
+
2089
+ List all Snapshot Labels
2090
+
2091
+ You can retrieve a list of all labels associated with a snapshot.
2092
+
2093
+ ### Examples
2094
+
2095
+ ```ruby
2096
+ require 'time'
2097
+ require 'ionoscloud'
2098
+ # setup authorization
2099
+ Ionoscloud.configure do |config|
2100
+ # Configure HTTP basic authorization: Basic Authentication
2101
+ config.username = 'YOUR USERNAME'
2102
+ config.password = 'YOUR PASSWORD'
2103
+
2104
+ # Configure API key authorization: Token Authentication
2105
+ config.api_key['Authorization'] = 'YOUR API KEY'
2106
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2107
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2108
+ end
2109
+
2110
+ api_instance = Ionoscloud::LabelsApi.new
2111
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
2112
+ opts = {
2113
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
2114
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
2115
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
2116
+ }
2117
+
2118
+ begin
2119
+ # List all Snapshot Labels
2120
+ result = api_instance.snapshots_labels_get(snapshot_id, opts)
2121
+ p result
2122
+ rescue Ionoscloud::ApiError => e
2123
+ puts "Error when calling LabelsApi->snapshots_labels_get: #{e}"
2124
+ end
2125
+ ```
2126
+
2127
+ #### Using the snapshots_labels_get_with_http_info variant
2128
+
2129
+ This returns an Array which contains the response data, status code and headers.
2130
+
2131
+ > <Array(<LabelResources>, Integer, Hash)> snapshots_labels_get_with_http_info(snapshot_id, opts)
2132
+
2133
+ ```ruby
2134
+ begin
2135
+ # List all Snapshot Labels
2136
+ data, status_code, headers = api_instance.snapshots_labels_get_with_http_info(snapshot_id, opts)
2137
+ p status_code # => 2xx
2138
+ p headers # => { ... }
2139
+ p data # => <LabelResources>
2140
+ rescue Ionoscloud::ApiError => e
2141
+ puts "Error when calling LabelsApi->snapshots_labels_get_with_http_info: #{e}"
2142
+ end
2143
+ ```
2144
+
2145
+ ### Parameters
2146
+
2147
+ | Name | Type | Description | Notes |
2148
+ | ---- | ---- | ----------- | ----- |
2149
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
2150
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
2151
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
2152
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
2153
+
2154
+ ### Return type
2155
+
2156
+ [**LabelResources**](LabelResources.md)
2157
+
2158
+ ### Authorization
2159
+
2160
+ Basic Authentication, Token Authentication
2161
+
2162
+ ### HTTP request headers
2163
+
2164
+ - **Content-Type**: Not defined
2165
+ - **Accept**: application/json
2166
+
2167
+
2168
+ ## snapshots_labels_post
2169
+
2170
+ > <LabelResource> snapshots_labels_post(snapshot_id, label, opts)
2171
+
2172
+ Add a Label to Snapshot
2173
+
2174
+ This will add a label to the snapshot.
2175
+
2176
+ ### Examples
2177
+
2178
+ ```ruby
2179
+ require 'time'
2180
+ require 'ionoscloud'
2181
+ # setup authorization
2182
+ Ionoscloud.configure do |config|
2183
+ # Configure HTTP basic authorization: Basic Authentication
2184
+ config.username = 'YOUR USERNAME'
2185
+ config.password = 'YOUR PASSWORD'
2186
+
2187
+ # Configure API key authorization: Token Authentication
2188
+ config.api_key['Authorization'] = 'YOUR API KEY'
2189
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2190
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2191
+ end
2192
+
2193
+ api_instance = Ionoscloud::LabelsApi.new
2194
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
2195
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
2196
+ opts = {
2197
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
2198
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
2199
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
2200
+ }
2201
+
2202
+ begin
2203
+ # Add a Label to Snapshot
2204
+ result = api_instance.snapshots_labels_post(snapshot_id, label, opts)
2205
+ p result
2206
+ rescue Ionoscloud::ApiError => e
2207
+ puts "Error when calling LabelsApi->snapshots_labels_post: #{e}"
2208
+ end
2209
+ ```
2210
+
2211
+ #### Using the snapshots_labels_post_with_http_info variant
2212
+
2213
+ This returns an Array which contains the response data, status code and headers.
2214
+
2215
+ > <Array(<LabelResource>, Integer, Hash)> snapshots_labels_post_with_http_info(snapshot_id, label, opts)
2216
+
2217
+ ```ruby
2218
+ begin
2219
+ # Add a Label to Snapshot
2220
+ data, status_code, headers = api_instance.snapshots_labels_post_with_http_info(snapshot_id, label, opts)
2221
+ p status_code # => 2xx
2222
+ p headers # => { ... }
2223
+ p data # => <LabelResource>
2224
+ rescue Ionoscloud::ApiError => e
2225
+ puts "Error when calling LabelsApi->snapshots_labels_post_with_http_info: #{e}"
2226
+ end
2227
+ ```
2228
+
2229
+ ### Parameters
2230
+
2231
+ | Name | Type | Description | Notes |
2232
+ | ---- | ---- | ----------- | ----- |
2233
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
2234
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
2235
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
2236
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
2237
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
2238
+
2239
+ ### Return type
2240
+
2241
+ [**LabelResource**](LabelResource.md)
2242
+
2243
+ ### Authorization
2244
+
2245
+ Basic Authentication, Token Authentication
2246
+
2247
+ ### HTTP request headers
2248
+
2249
+ - **Content-Type**: application/json
2250
+ - **Accept**: application/json
2251
+
2252
+
2253
+ ## snapshots_labels_put
2254
+
2255
+ > <LabelResource> snapshots_labels_put(snapshot_id, key, label, opts)
2256
+
2257
+ Modify a Label of Snapshot
2258
+
2259
+ This will modify the value of the label on a snapshot.
2260
+
2261
+ ### Examples
2262
+
2263
+ ```ruby
2264
+ require 'time'
2265
+ require 'ionoscloud'
2266
+ # setup authorization
2267
+ Ionoscloud.configure do |config|
2268
+ # Configure HTTP basic authorization: Basic Authentication
2269
+ config.username = 'YOUR USERNAME'
2270
+ config.password = 'YOUR PASSWORD'
2271
+
2272
+ # Configure API key authorization: Token Authentication
2273
+ config.api_key['Authorization'] = 'YOUR API KEY'
2274
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2275
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2276
+ end
2277
+
2278
+ api_instance = Ionoscloud::LabelsApi.new
2279
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
2280
+ key = 'key_example' # String | The key of the Label
2281
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
2282
+ opts = {
2283
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
2284
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
2285
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
2286
+ }
2287
+
2288
+ begin
2289
+ # Modify a Label of Snapshot
2290
+ result = api_instance.snapshots_labels_put(snapshot_id, key, label, opts)
2291
+ p result
2292
+ rescue Ionoscloud::ApiError => e
2293
+ puts "Error when calling LabelsApi->snapshots_labels_put: #{e}"
2294
+ end
2295
+ ```
2296
+
2297
+ #### Using the snapshots_labels_put_with_http_info variant
2298
+
2299
+ This returns an Array which contains the response data, status code and headers.
2300
+
2301
+ > <Array(<LabelResource>, Integer, Hash)> snapshots_labels_put_with_http_info(snapshot_id, key, label, opts)
2302
+
2303
+ ```ruby
2304
+ begin
2305
+ # Modify a Label of Snapshot
2306
+ data, status_code, headers = api_instance.snapshots_labels_put_with_http_info(snapshot_id, key, label, opts)
2307
+ p status_code # => 2xx
2308
+ p headers # => { ... }
2309
+ p data # => <LabelResource>
2310
+ rescue Ionoscloud::ApiError => e
2311
+ puts "Error when calling LabelsApi->snapshots_labels_put_with_http_info: #{e}"
2312
+ end
2313
+ ```
2314
+
2315
+ ### Parameters
2316
+
2317
+ | Name | Type | Description | Notes |
2318
+ | ---- | ---- | ----------- | ----- |
2319
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
2320
+ | **key** | **String** | The key of the Label | |
2321
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
2322
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
2323
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
2324
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
2325
+
2326
+ ### Return type
2327
+
2328
+ [**LabelResource**](LabelResource.md)
2329
+
2330
+ ### Authorization
2331
+
2332
+ Basic Authentication, Token Authentication
2333
+
2334
+ ### HTTP request headers
2335
+
2336
+ - **Content-Type**: application/json
2337
+ - **Accept**: application/json
2338
+