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