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
|
@@ -0,0 +1,1908 @@
|
|
|
1
|
+
# ServersApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**datacenters_servers_cdroms_delete**](ServersApi.md#datacenters_servers_cdroms_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Detach CD-ROMs |
|
|
8
|
+
| [**datacenters_servers_cdroms_find_by_id**](ServersApi.md#datacenters_servers_cdroms_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Retrieve attached CD-ROMs |
|
|
9
|
+
| [**datacenters_servers_cdroms_get**](ServersApi.md#datacenters_servers_cdroms_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/cdroms | List attached CD-ROMs |
|
|
10
|
+
| [**datacenters_servers_cdroms_post**](ServersApi.md#datacenters_servers_cdroms_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/cdroms | Attach CD-ROMs |
|
|
11
|
+
| [**datacenters_servers_delete**](ServersApi.md#datacenters_servers_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId} | Delete servers |
|
|
12
|
+
| [**datacenters_servers_find_by_id**](ServersApi.md#datacenters_servers_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId} | Retrieve servers by ID |
|
|
13
|
+
| [**datacenters_servers_get**](ServersApi.md#datacenters_servers_get) | **GET** /datacenters/{datacenterId}/servers | List servers |
|
|
14
|
+
| [**datacenters_servers_patch**](ServersApi.md#datacenters_servers_patch) | **PATCH** /datacenters/{datacenterId}/servers/{serverId} | Partially modify servers |
|
|
15
|
+
| [**datacenters_servers_post**](ServersApi.md#datacenters_servers_post) | **POST** /datacenters/{datacenterId}/servers | Create servers |
|
|
16
|
+
| [**datacenters_servers_put**](ServersApi.md#datacenters_servers_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId} | Modify servers |
|
|
17
|
+
| [**datacenters_servers_reboot_post**](ServersApi.md#datacenters_servers_reboot_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/reboot | Reboot servers |
|
|
18
|
+
| [**datacenters_servers_remote_console_get**](ServersApi.md#datacenters_servers_remote_console_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/remoteconsole | Get Remote Console link |
|
|
19
|
+
| [**datacenters_servers_resume_post**](ServersApi.md#datacenters_servers_resume_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/resume | Resume Cubes instances |
|
|
20
|
+
| [**datacenters_servers_start_post**](ServersApi.md#datacenters_servers_start_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/start | Start servers |
|
|
21
|
+
| [**datacenters_servers_stop_post**](ServersApi.md#datacenters_servers_stop_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/stop | Stop VMs |
|
|
22
|
+
| [**datacenters_servers_suspend_post**](ServersApi.md#datacenters_servers_suspend_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/suspend | Suspend Cubes instances |
|
|
23
|
+
| [**datacenters_servers_token_get**](ServersApi.md#datacenters_servers_token_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/token | Get JASON Web Token |
|
|
24
|
+
| [**datacenters_servers_upgrade_post**](ServersApi.md#datacenters_servers_upgrade_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/upgrade | Upgrade servers |
|
|
25
|
+
| [**datacenters_servers_volumes_delete**](ServersApi.md#datacenters_servers_volumes_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Detach volumes |
|
|
26
|
+
| [**datacenters_servers_volumes_find_by_id**](ServersApi.md#datacenters_servers_volumes_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Retrieve attached volumes |
|
|
27
|
+
| [**datacenters_servers_volumes_get**](ServersApi.md#datacenters_servers_volumes_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/volumes | List attached volumes |
|
|
28
|
+
| [**datacenters_servers_volumes_post**](ServersApi.md#datacenters_servers_volumes_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/volumes | Attach volumes |
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## datacenters_servers_cdroms_delete
|
|
32
|
+
|
|
33
|
+
> datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, opts)
|
|
34
|
+
|
|
35
|
+
Detach CD-ROMs
|
|
36
|
+
|
|
37
|
+
Detach the specified CD-ROM from the server.
|
|
38
|
+
|
|
39
|
+
### Examples
|
|
40
|
+
|
|
41
|
+
```ruby
|
|
42
|
+
require 'time'
|
|
43
|
+
require 'ionoscloud'
|
|
44
|
+
# setup authorization
|
|
45
|
+
Ionoscloud.configure do |config|
|
|
46
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
47
|
+
config.username = 'YOUR USERNAME'
|
|
48
|
+
config.password = 'YOUR PASSWORD'
|
|
49
|
+
|
|
50
|
+
# Configure API key authorization: Token Authentication
|
|
51
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
52
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
53
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
57
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
58
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
59
|
+
cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM.
|
|
60
|
+
opts = {
|
|
61
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
62
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
63
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
begin
|
|
67
|
+
# Detach CD-ROMs
|
|
68
|
+
api_instance.datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, opts)
|
|
69
|
+
rescue Ionoscloud::ApiError => e
|
|
70
|
+
puts "Error when calling ServersApi->datacenters_servers_cdroms_delete: #{e}"
|
|
71
|
+
end
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
#### Using the datacenters_servers_cdroms_delete_with_http_info variant
|
|
75
|
+
|
|
76
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
77
|
+
|
|
78
|
+
> <Array(nil, Integer, Hash)> datacenters_servers_cdroms_delete_with_http_info(datacenter_id, server_id, cdrom_id, opts)
|
|
79
|
+
|
|
80
|
+
```ruby
|
|
81
|
+
begin
|
|
82
|
+
# Detach CD-ROMs
|
|
83
|
+
data, status_code, headers = api_instance.datacenters_servers_cdroms_delete_with_http_info(datacenter_id, server_id, cdrom_id, opts)
|
|
84
|
+
p status_code # => 2xx
|
|
85
|
+
p headers # => { ... }
|
|
86
|
+
p data # => nil
|
|
87
|
+
rescue Ionoscloud::ApiError => e
|
|
88
|
+
puts "Error when calling ServersApi->datacenters_servers_cdroms_delete_with_http_info: #{e}"
|
|
89
|
+
end
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
| Name | Type | Description | Notes |
|
|
95
|
+
| ---- | ---- | ----------- | ----- |
|
|
96
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
97
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
98
|
+
| **cdrom_id** | **String** | The unique ID of the CD-ROM. | |
|
|
99
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
100
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
101
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
nil (empty response body)
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
Basic Authentication, Token Authentication
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
## datacenters_servers_cdroms_find_by_id
|
|
118
|
+
|
|
119
|
+
> <Image> datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, opts)
|
|
120
|
+
|
|
121
|
+
Retrieve attached CD-ROMs
|
|
122
|
+
|
|
123
|
+
Retrieve the properties of the CD-ROM, attached to the specified server.
|
|
124
|
+
|
|
125
|
+
### Examples
|
|
126
|
+
|
|
127
|
+
```ruby
|
|
128
|
+
require 'time'
|
|
129
|
+
require 'ionoscloud'
|
|
130
|
+
# setup authorization
|
|
131
|
+
Ionoscloud.configure do |config|
|
|
132
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
133
|
+
config.username = 'YOUR USERNAME'
|
|
134
|
+
config.password = 'YOUR PASSWORD'
|
|
135
|
+
|
|
136
|
+
# Configure API key authorization: Token Authentication
|
|
137
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
138
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
139
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
143
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
144
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
145
|
+
cdrom_id = 'cdrom_id_example' # String | The unique ID of the CD-ROM.
|
|
146
|
+
opts = {
|
|
147
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
148
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
149
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
begin
|
|
153
|
+
# Retrieve attached CD-ROMs
|
|
154
|
+
result = api_instance.datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, opts)
|
|
155
|
+
p result
|
|
156
|
+
rescue Ionoscloud::ApiError => e
|
|
157
|
+
puts "Error when calling ServersApi->datacenters_servers_cdroms_find_by_id: #{e}"
|
|
158
|
+
end
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
#### Using the datacenters_servers_cdroms_find_by_id_with_http_info variant
|
|
162
|
+
|
|
163
|
+
This returns an Array which contains the response data, status code and headers.
|
|
164
|
+
|
|
165
|
+
> <Array(<Image>, Integer, Hash)> datacenters_servers_cdroms_find_by_id_with_http_info(datacenter_id, server_id, cdrom_id, opts)
|
|
166
|
+
|
|
167
|
+
```ruby
|
|
168
|
+
begin
|
|
169
|
+
# Retrieve attached CD-ROMs
|
|
170
|
+
data, status_code, headers = api_instance.datacenters_servers_cdroms_find_by_id_with_http_info(datacenter_id, server_id, cdrom_id, opts)
|
|
171
|
+
p status_code # => 2xx
|
|
172
|
+
p headers # => { ... }
|
|
173
|
+
p data # => <Image>
|
|
174
|
+
rescue Ionoscloud::ApiError => e
|
|
175
|
+
puts "Error when calling ServersApi->datacenters_servers_cdroms_find_by_id_with_http_info: #{e}"
|
|
176
|
+
end
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### Parameters
|
|
180
|
+
|
|
181
|
+
| Name | Type | Description | Notes |
|
|
182
|
+
| ---- | ---- | ----------- | ----- |
|
|
183
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
184
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
185
|
+
| **cdrom_id** | **String** | The unique ID of the CD-ROM. | |
|
|
186
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
187
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
188
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
189
|
+
|
|
190
|
+
### Return type
|
|
191
|
+
|
|
192
|
+
[**Image**](../models/Image.md)
|
|
193
|
+
|
|
194
|
+
### Authorization
|
|
195
|
+
|
|
196
|
+
Basic Authentication, Token Authentication
|
|
197
|
+
|
|
198
|
+
### HTTP request headers
|
|
199
|
+
|
|
200
|
+
- **Content-Type**: Not defined
|
|
201
|
+
- **Accept**: application/json
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
## datacenters_servers_cdroms_get
|
|
205
|
+
|
|
206
|
+
> <Cdroms> datacenters_servers_cdroms_get(datacenter_id, server_id, opts)
|
|
207
|
+
|
|
208
|
+
List attached CD-ROMs
|
|
209
|
+
|
|
210
|
+
List all CD-ROMs, attached to the specified server.
|
|
211
|
+
|
|
212
|
+
### Examples
|
|
213
|
+
|
|
214
|
+
```ruby
|
|
215
|
+
require 'time'
|
|
216
|
+
require 'ionoscloud'
|
|
217
|
+
# setup authorization
|
|
218
|
+
Ionoscloud.configure do |config|
|
|
219
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
220
|
+
config.username = 'YOUR USERNAME'
|
|
221
|
+
config.password = 'YOUR PASSWORD'
|
|
222
|
+
|
|
223
|
+
# Configure API key authorization: Token Authentication
|
|
224
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
225
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
226
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
230
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
231
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
232
|
+
opts = {
|
|
233
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
234
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
235
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
236
|
+
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
|
|
237
|
+
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
begin
|
|
241
|
+
# List attached CD-ROMs
|
|
242
|
+
result = api_instance.datacenters_servers_cdroms_get(datacenter_id, server_id, opts)
|
|
243
|
+
p result
|
|
244
|
+
rescue Ionoscloud::ApiError => e
|
|
245
|
+
puts "Error when calling ServersApi->datacenters_servers_cdroms_get: #{e}"
|
|
246
|
+
end
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
#### Using the datacenters_servers_cdroms_get_with_http_info variant
|
|
250
|
+
|
|
251
|
+
This returns an Array which contains the response data, status code and headers.
|
|
252
|
+
|
|
253
|
+
> <Array(<Cdroms>, Integer, Hash)> datacenters_servers_cdroms_get_with_http_info(datacenter_id, server_id, opts)
|
|
254
|
+
|
|
255
|
+
```ruby
|
|
256
|
+
begin
|
|
257
|
+
# List attached CD-ROMs
|
|
258
|
+
data, status_code, headers = api_instance.datacenters_servers_cdroms_get_with_http_info(datacenter_id, server_id, opts)
|
|
259
|
+
p status_code # => 2xx
|
|
260
|
+
p headers # => { ... }
|
|
261
|
+
p data # => <Cdroms>
|
|
262
|
+
rescue Ionoscloud::ApiError => e
|
|
263
|
+
puts "Error when calling ServersApi->datacenters_servers_cdroms_get_with_http_info: #{e}"
|
|
264
|
+
end
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
### Parameters
|
|
268
|
+
|
|
269
|
+
| Name | Type | Description | Notes |
|
|
270
|
+
| ---- | ---- | ----------- | ----- |
|
|
271
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
272
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
273
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
274
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
275
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
276
|
+
| **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). | [optional][default to 0] |
|
|
277
|
+
| **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
|
|
278
|
+
|
|
279
|
+
### Return type
|
|
280
|
+
|
|
281
|
+
[**Cdroms**](../models/Cdroms.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_servers_cdroms_post
|
|
294
|
+
|
|
295
|
+
> <Image> datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, opts)
|
|
296
|
+
|
|
297
|
+
Attach CD-ROMs
|
|
298
|
+
|
|
299
|
+
Attach a CD-ROM to an existing server. Up to two CD-ROMs can be attached to the same server.
|
|
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::ServersApi.new
|
|
319
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
320
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
321
|
+
cdrom = Ionoscloud::Image.new({properties: Ionoscloud::ImageProperties.new({licence_type: 'UNKNOWN'})}) # Image | The CD-ROM to be attached.
|
|
322
|
+
opts = {
|
|
323
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
324
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
325
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
begin
|
|
329
|
+
# Attach CD-ROMs
|
|
330
|
+
result = api_instance.datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, opts)
|
|
331
|
+
p result
|
|
332
|
+
rescue Ionoscloud::ApiError => e
|
|
333
|
+
puts "Error when calling ServersApi->datacenters_servers_cdroms_post: #{e}"
|
|
334
|
+
end
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
#### Using the datacenters_servers_cdroms_post_with_http_info variant
|
|
338
|
+
|
|
339
|
+
This returns an Array which contains the response data, status code and headers.
|
|
340
|
+
|
|
341
|
+
> <Array(<Image>, Integer, Hash)> datacenters_servers_cdroms_post_with_http_info(datacenter_id, server_id, cdrom, opts)
|
|
342
|
+
|
|
343
|
+
```ruby
|
|
344
|
+
begin
|
|
345
|
+
# Attach CD-ROMs
|
|
346
|
+
data, status_code, headers = api_instance.datacenters_servers_cdroms_post_with_http_info(datacenter_id, server_id, cdrom, opts)
|
|
347
|
+
p status_code # => 2xx
|
|
348
|
+
p headers # => { ... }
|
|
349
|
+
p data # => <Image>
|
|
350
|
+
rescue Ionoscloud::ApiError => e
|
|
351
|
+
puts "Error when calling ServersApi->datacenters_servers_cdroms_post_with_http_info: #{e}"
|
|
352
|
+
end
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
### Parameters
|
|
356
|
+
|
|
357
|
+
| Name | Type | Description | Notes |
|
|
358
|
+
| ---- | ---- | ----------- | ----- |
|
|
359
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
360
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
361
|
+
| **cdrom** | [**Image**](Image.md) | The CD-ROM to be attached. | |
|
|
362
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
363
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
364
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
365
|
+
|
|
366
|
+
### Return type
|
|
367
|
+
|
|
368
|
+
[**Image**](../models/Image.md)
|
|
369
|
+
|
|
370
|
+
### Authorization
|
|
371
|
+
|
|
372
|
+
Basic Authentication, Token Authentication
|
|
373
|
+
|
|
374
|
+
### HTTP request headers
|
|
375
|
+
|
|
376
|
+
- **Content-Type**: application/json
|
|
377
|
+
- **Accept**: application/json
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
## datacenters_servers_delete
|
|
381
|
+
|
|
382
|
+
> datacenters_servers_delete(datacenter_id, server_id, opts)
|
|
383
|
+
|
|
384
|
+
Delete servers
|
|
385
|
+
|
|
386
|
+
Delete the specified server in your data center. The attached storage volumes will not be removed — a separate API call must be made for these actions.
|
|
387
|
+
|
|
388
|
+
### Examples
|
|
389
|
+
|
|
390
|
+
```ruby
|
|
391
|
+
require 'time'
|
|
392
|
+
require 'ionoscloud'
|
|
393
|
+
# setup authorization
|
|
394
|
+
Ionoscloud.configure do |config|
|
|
395
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
396
|
+
config.username = 'YOUR USERNAME'
|
|
397
|
+
config.password = 'YOUR PASSWORD'
|
|
398
|
+
|
|
399
|
+
# Configure API key authorization: Token Authentication
|
|
400
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
401
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
402
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
403
|
+
end
|
|
404
|
+
|
|
405
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
406
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
407
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
408
|
+
opts = {
|
|
409
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
410
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
411
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
begin
|
|
415
|
+
# Delete servers
|
|
416
|
+
api_instance.datacenters_servers_delete(datacenter_id, server_id, opts)
|
|
417
|
+
rescue Ionoscloud::ApiError => e
|
|
418
|
+
puts "Error when calling ServersApi->datacenters_servers_delete: #{e}"
|
|
419
|
+
end
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
#### Using the datacenters_servers_delete_with_http_info variant
|
|
423
|
+
|
|
424
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
425
|
+
|
|
426
|
+
> <Array(nil, Integer, Hash)> datacenters_servers_delete_with_http_info(datacenter_id, server_id, opts)
|
|
427
|
+
|
|
428
|
+
```ruby
|
|
429
|
+
begin
|
|
430
|
+
# Delete servers
|
|
431
|
+
data, status_code, headers = api_instance.datacenters_servers_delete_with_http_info(datacenter_id, server_id, opts)
|
|
432
|
+
p status_code # => 2xx
|
|
433
|
+
p headers # => { ... }
|
|
434
|
+
p data # => nil
|
|
435
|
+
rescue Ionoscloud::ApiError => e
|
|
436
|
+
puts "Error when calling ServersApi->datacenters_servers_delete_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
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
446
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
447
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
448
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
449
|
+
|
|
450
|
+
### Return type
|
|
451
|
+
|
|
452
|
+
nil (empty response body)
|
|
453
|
+
|
|
454
|
+
### Authorization
|
|
455
|
+
|
|
456
|
+
Basic Authentication, Token Authentication
|
|
457
|
+
|
|
458
|
+
### HTTP request headers
|
|
459
|
+
|
|
460
|
+
- **Content-Type**: Not defined
|
|
461
|
+
- **Accept**: application/json
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
## datacenters_servers_find_by_id
|
|
465
|
+
|
|
466
|
+
> <Server> datacenters_servers_find_by_id(datacenter_id, server_id, opts)
|
|
467
|
+
|
|
468
|
+
Retrieve servers by ID
|
|
469
|
+
|
|
470
|
+
Retrieve information about the specified server within the data center, such as its configuration, provisioning status, and so on.
|
|
471
|
+
|
|
472
|
+
### Examples
|
|
473
|
+
|
|
474
|
+
```ruby
|
|
475
|
+
require 'time'
|
|
476
|
+
require 'ionoscloud'
|
|
477
|
+
# setup authorization
|
|
478
|
+
Ionoscloud.configure do |config|
|
|
479
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
480
|
+
config.username = 'YOUR USERNAME'
|
|
481
|
+
config.password = 'YOUR PASSWORD'
|
|
482
|
+
|
|
483
|
+
# Configure API key authorization: Token Authentication
|
|
484
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
485
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
486
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
487
|
+
end
|
|
488
|
+
|
|
489
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
490
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
491
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
492
|
+
opts = {
|
|
493
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
494
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
495
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
begin
|
|
499
|
+
# Retrieve servers by ID
|
|
500
|
+
result = api_instance.datacenters_servers_find_by_id(datacenter_id, server_id, opts)
|
|
501
|
+
p result
|
|
502
|
+
rescue Ionoscloud::ApiError => e
|
|
503
|
+
puts "Error when calling ServersApi->datacenters_servers_find_by_id: #{e}"
|
|
504
|
+
end
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
#### Using the datacenters_servers_find_by_id_with_http_info variant
|
|
508
|
+
|
|
509
|
+
This returns an Array which contains the response data, status code and headers.
|
|
510
|
+
|
|
511
|
+
> <Array(<Server>, Integer, Hash)> datacenters_servers_find_by_id_with_http_info(datacenter_id, server_id, opts)
|
|
512
|
+
|
|
513
|
+
```ruby
|
|
514
|
+
begin
|
|
515
|
+
# Retrieve servers by ID
|
|
516
|
+
data, status_code, headers = api_instance.datacenters_servers_find_by_id_with_http_info(datacenter_id, server_id, opts)
|
|
517
|
+
p status_code # => 2xx
|
|
518
|
+
p headers # => { ... }
|
|
519
|
+
p data # => <Server>
|
|
520
|
+
rescue Ionoscloud::ApiError => e
|
|
521
|
+
puts "Error when calling ServersApi->datacenters_servers_find_by_id_with_http_info: #{e}"
|
|
522
|
+
end
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
### Parameters
|
|
526
|
+
|
|
527
|
+
| Name | Type | Description | Notes |
|
|
528
|
+
| ---- | ---- | ----------- | ----- |
|
|
529
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
530
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
531
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
532
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
533
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
534
|
+
|
|
535
|
+
### Return type
|
|
536
|
+
|
|
537
|
+
[**Server**](../models/Server.md)
|
|
538
|
+
|
|
539
|
+
### Authorization
|
|
540
|
+
|
|
541
|
+
Basic Authentication, Token Authentication
|
|
542
|
+
|
|
543
|
+
### HTTP request headers
|
|
544
|
+
|
|
545
|
+
- **Content-Type**: Not defined
|
|
546
|
+
- **Accept**: application/json
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
## datacenters_servers_get
|
|
550
|
+
|
|
551
|
+
> <Servers> datacenters_servers_get(datacenter_id, opts)
|
|
552
|
+
|
|
553
|
+
List servers
|
|
554
|
+
|
|
555
|
+
List all servers within the data center.
|
|
556
|
+
|
|
557
|
+
### Examples
|
|
558
|
+
|
|
559
|
+
```ruby
|
|
560
|
+
require 'time'
|
|
561
|
+
require 'ionoscloud'
|
|
562
|
+
# setup authorization
|
|
563
|
+
Ionoscloud.configure do |config|
|
|
564
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
565
|
+
config.username = 'YOUR USERNAME'
|
|
566
|
+
config.password = 'YOUR PASSWORD'
|
|
567
|
+
|
|
568
|
+
# Configure API key authorization: Token Authentication
|
|
569
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
570
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
571
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
572
|
+
end
|
|
573
|
+
|
|
574
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
575
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
576
|
+
opts = {
|
|
577
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
578
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
579
|
+
upgrade_needed: true, # Boolean | Filter servers that can or that cannot be upgraded.
|
|
580
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
581
|
+
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
|
|
582
|
+
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
begin
|
|
586
|
+
# List servers
|
|
587
|
+
result = api_instance.datacenters_servers_get(datacenter_id, opts)
|
|
588
|
+
p result
|
|
589
|
+
rescue Ionoscloud::ApiError => e
|
|
590
|
+
puts "Error when calling ServersApi->datacenters_servers_get: #{e}"
|
|
591
|
+
end
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
#### Using the datacenters_servers_get_with_http_info variant
|
|
595
|
+
|
|
596
|
+
This returns an Array which contains the response data, status code and headers.
|
|
597
|
+
|
|
598
|
+
> <Array(<Servers>, Integer, Hash)> datacenters_servers_get_with_http_info(datacenter_id, opts)
|
|
599
|
+
|
|
600
|
+
```ruby
|
|
601
|
+
begin
|
|
602
|
+
# List servers
|
|
603
|
+
data, status_code, headers = api_instance.datacenters_servers_get_with_http_info(datacenter_id, opts)
|
|
604
|
+
p status_code # => 2xx
|
|
605
|
+
p headers # => { ... }
|
|
606
|
+
p data # => <Servers>
|
|
607
|
+
rescue Ionoscloud::ApiError => e
|
|
608
|
+
puts "Error when calling ServersApi->datacenters_servers_get_with_http_info: #{e}"
|
|
609
|
+
end
|
|
610
|
+
```
|
|
611
|
+
|
|
612
|
+
### Parameters
|
|
613
|
+
|
|
614
|
+
| Name | Type | Description | Notes |
|
|
615
|
+
| ---- | ---- | ----------- | ----- |
|
|
616
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
617
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
618
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
619
|
+
| **upgrade_needed** | **Boolean** | Filter servers that can or that cannot be upgraded. | [optional] |
|
|
620
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
621
|
+
| **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). | [optional][default to 0] |
|
|
622
|
+
| **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
|
|
623
|
+
|
|
624
|
+
### Return type
|
|
625
|
+
|
|
626
|
+
[**Servers**](../models/Servers.md)
|
|
627
|
+
|
|
628
|
+
### Authorization
|
|
629
|
+
|
|
630
|
+
Basic Authentication, Token Authentication
|
|
631
|
+
|
|
632
|
+
### HTTP request headers
|
|
633
|
+
|
|
634
|
+
- **Content-Type**: Not defined
|
|
635
|
+
- **Accept**: application/json
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
## datacenters_servers_patch
|
|
639
|
+
|
|
640
|
+
> <Server> datacenters_servers_patch(datacenter_id, server_id, server, opts)
|
|
641
|
+
|
|
642
|
+
Partially modify servers
|
|
643
|
+
|
|
644
|
+
Update the properties of the specified server within the data center.
|
|
645
|
+
|
|
646
|
+
### Examples
|
|
647
|
+
|
|
648
|
+
```ruby
|
|
649
|
+
require 'time'
|
|
650
|
+
require 'ionoscloud'
|
|
651
|
+
# setup authorization
|
|
652
|
+
Ionoscloud.configure do |config|
|
|
653
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
654
|
+
config.username = 'YOUR USERNAME'
|
|
655
|
+
config.password = 'YOUR PASSWORD'
|
|
656
|
+
|
|
657
|
+
# Configure API key authorization: Token Authentication
|
|
658
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
659
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
660
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
661
|
+
end
|
|
662
|
+
|
|
663
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
664
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
665
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
666
|
+
server = Ionoscloud::ServerProperties.new({cores: 4, ram: 4096}) # ServerProperties | The properties of the server to be updated.
|
|
667
|
+
opts = {
|
|
668
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
669
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
670
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
begin
|
|
674
|
+
# Partially modify servers
|
|
675
|
+
result = api_instance.datacenters_servers_patch(datacenter_id, server_id, server, opts)
|
|
676
|
+
p result
|
|
677
|
+
rescue Ionoscloud::ApiError => e
|
|
678
|
+
puts "Error when calling ServersApi->datacenters_servers_patch: #{e}"
|
|
679
|
+
end
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
#### Using the datacenters_servers_patch_with_http_info variant
|
|
683
|
+
|
|
684
|
+
This returns an Array which contains the response data, status code and headers.
|
|
685
|
+
|
|
686
|
+
> <Array(<Server>, Integer, Hash)> datacenters_servers_patch_with_http_info(datacenter_id, server_id, server, opts)
|
|
687
|
+
|
|
688
|
+
```ruby
|
|
689
|
+
begin
|
|
690
|
+
# Partially modify servers
|
|
691
|
+
data, status_code, headers = api_instance.datacenters_servers_patch_with_http_info(datacenter_id, server_id, server, opts)
|
|
692
|
+
p status_code # => 2xx
|
|
693
|
+
p headers # => { ... }
|
|
694
|
+
p data # => <Server>
|
|
695
|
+
rescue Ionoscloud::ApiError => e
|
|
696
|
+
puts "Error when calling ServersApi->datacenters_servers_patch_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 data center. | |
|
|
705
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
706
|
+
| **server** | [**ServerProperties**](ServerProperties.md) | The properties of the server to be updated. | |
|
|
707
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
708
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
709
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
710
|
+
|
|
711
|
+
### Return type
|
|
712
|
+
|
|
713
|
+
[**Server**](../models/Server.md)
|
|
714
|
+
|
|
715
|
+
### Authorization
|
|
716
|
+
|
|
717
|
+
Basic Authentication, Token Authentication
|
|
718
|
+
|
|
719
|
+
### HTTP request headers
|
|
720
|
+
|
|
721
|
+
- **Content-Type**: application/json
|
|
722
|
+
- **Accept**: application/json
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
## datacenters_servers_post
|
|
726
|
+
|
|
727
|
+
> <Server> datacenters_servers_post(datacenter_id, server, opts)
|
|
728
|
+
|
|
729
|
+
Create servers
|
|
730
|
+
|
|
731
|
+
Create a server within the specified data center. You can also use this request to configure the boot volumes and connect to existing LANs at the same time.
|
|
732
|
+
|
|
733
|
+
### Examples
|
|
734
|
+
|
|
735
|
+
```ruby
|
|
736
|
+
require 'time'
|
|
737
|
+
require 'ionoscloud'
|
|
738
|
+
# setup authorization
|
|
739
|
+
Ionoscloud.configure do |config|
|
|
740
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
741
|
+
config.username = 'YOUR USERNAME'
|
|
742
|
+
config.password = 'YOUR PASSWORD'
|
|
743
|
+
|
|
744
|
+
# Configure API key authorization: Token Authentication
|
|
745
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
746
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
747
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
748
|
+
end
|
|
749
|
+
|
|
750
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
751
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
752
|
+
server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | The server to create.
|
|
753
|
+
opts = {
|
|
754
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
755
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
756
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
757
|
+
}
|
|
758
|
+
|
|
759
|
+
begin
|
|
760
|
+
# Create servers
|
|
761
|
+
result = api_instance.datacenters_servers_post(datacenter_id, server, opts)
|
|
762
|
+
p result
|
|
763
|
+
rescue Ionoscloud::ApiError => e
|
|
764
|
+
puts "Error when calling ServersApi->datacenters_servers_post: #{e}"
|
|
765
|
+
end
|
|
766
|
+
```
|
|
767
|
+
|
|
768
|
+
#### Using the datacenters_servers_post_with_http_info variant
|
|
769
|
+
|
|
770
|
+
This returns an Array which contains the response data, status code and headers.
|
|
771
|
+
|
|
772
|
+
> <Array(<Server>, Integer, Hash)> datacenters_servers_post_with_http_info(datacenter_id, server, opts)
|
|
773
|
+
|
|
774
|
+
```ruby
|
|
775
|
+
begin
|
|
776
|
+
# Create servers
|
|
777
|
+
data, status_code, headers = api_instance.datacenters_servers_post_with_http_info(datacenter_id, server, opts)
|
|
778
|
+
p status_code # => 2xx
|
|
779
|
+
p headers # => { ... }
|
|
780
|
+
p data # => <Server>
|
|
781
|
+
rescue Ionoscloud::ApiError => e
|
|
782
|
+
puts "Error when calling ServersApi->datacenters_servers_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 data center. | |
|
|
791
|
+
| **server** | [**Server**](Server.md) | The server to create. | |
|
|
792
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
793
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
794
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
795
|
+
|
|
796
|
+
### Return type
|
|
797
|
+
|
|
798
|
+
[**Server**](../models/Server.md)
|
|
799
|
+
|
|
800
|
+
### Authorization
|
|
801
|
+
|
|
802
|
+
Basic Authentication, Token Authentication
|
|
803
|
+
|
|
804
|
+
### HTTP request headers
|
|
805
|
+
|
|
806
|
+
- **Content-Type**: application/json
|
|
807
|
+
- **Accept**: application/json
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
## datacenters_servers_put
|
|
811
|
+
|
|
812
|
+
> <Server> datacenters_servers_put(datacenter_id, server_id, server, opts)
|
|
813
|
+
|
|
814
|
+
Modify servers
|
|
815
|
+
|
|
816
|
+
Modify the properties of the specified server within the data center. Starting with v5, the 'allowReboot' attribute is retired; while previously required for changing certain server properties, this behavior is now implicit, and the backend will perform this automatically. For example, in earlier versions, when the CPU family is changed, 'allowReboot' had to be set to 'true'; this is no longer required, the reboot will be performed automatically.
|
|
817
|
+
|
|
818
|
+
### Examples
|
|
819
|
+
|
|
820
|
+
```ruby
|
|
821
|
+
require 'time'
|
|
822
|
+
require 'ionoscloud'
|
|
823
|
+
# setup authorization
|
|
824
|
+
Ionoscloud.configure do |config|
|
|
825
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
826
|
+
config.username = 'YOUR USERNAME'
|
|
827
|
+
config.password = 'YOUR PASSWORD'
|
|
828
|
+
|
|
829
|
+
# Configure API key authorization: Token Authentication
|
|
830
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
831
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
832
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
833
|
+
end
|
|
834
|
+
|
|
835
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
836
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
837
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
838
|
+
server = Ionoscloud::Server.new({properties: Ionoscloud::ServerProperties.new({cores: 4, ram: 4096})}) # Server | The modified server
|
|
839
|
+
opts = {
|
|
840
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
841
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
842
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
843
|
+
}
|
|
844
|
+
|
|
845
|
+
begin
|
|
846
|
+
# Modify servers
|
|
847
|
+
result = api_instance.datacenters_servers_put(datacenter_id, server_id, server, opts)
|
|
848
|
+
p result
|
|
849
|
+
rescue Ionoscloud::ApiError => e
|
|
850
|
+
puts "Error when calling ServersApi->datacenters_servers_put: #{e}"
|
|
851
|
+
end
|
|
852
|
+
```
|
|
853
|
+
|
|
854
|
+
#### Using the datacenters_servers_put_with_http_info variant
|
|
855
|
+
|
|
856
|
+
This returns an Array which contains the response data, status code and headers.
|
|
857
|
+
|
|
858
|
+
> <Array(<Server>, Integer, Hash)> datacenters_servers_put_with_http_info(datacenter_id, server_id, server, opts)
|
|
859
|
+
|
|
860
|
+
```ruby
|
|
861
|
+
begin
|
|
862
|
+
# Modify servers
|
|
863
|
+
data, status_code, headers = api_instance.datacenters_servers_put_with_http_info(datacenter_id, server_id, server, opts)
|
|
864
|
+
p status_code # => 2xx
|
|
865
|
+
p headers # => { ... }
|
|
866
|
+
p data # => <Server>
|
|
867
|
+
rescue Ionoscloud::ApiError => e
|
|
868
|
+
puts "Error when calling ServersApi->datacenters_servers_put_with_http_info: #{e}"
|
|
869
|
+
end
|
|
870
|
+
```
|
|
871
|
+
|
|
872
|
+
### Parameters
|
|
873
|
+
|
|
874
|
+
| Name | Type | Description | Notes |
|
|
875
|
+
| ---- | ---- | ----------- | ----- |
|
|
876
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
877
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
878
|
+
| **server** | [**Server**](Server.md) | The modified server | |
|
|
879
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
880
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
881
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
882
|
+
|
|
883
|
+
### Return type
|
|
884
|
+
|
|
885
|
+
[**Server**](../models/Server.md)
|
|
886
|
+
|
|
887
|
+
### Authorization
|
|
888
|
+
|
|
889
|
+
Basic Authentication, Token Authentication
|
|
890
|
+
|
|
891
|
+
### HTTP request headers
|
|
892
|
+
|
|
893
|
+
- **Content-Type**: application/json
|
|
894
|
+
- **Accept**: application/json
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
## datacenters_servers_reboot_post
|
|
898
|
+
|
|
899
|
+
> datacenters_servers_reboot_post(datacenter_id, server_id, opts)
|
|
900
|
+
|
|
901
|
+
Reboot servers
|
|
902
|
+
|
|
903
|
+
Force a hard reboot of the specified server within the data center. Don't use this method if you wish to reboot gracefully. This is an equivalent of powering down a computer and turning it back on.
|
|
904
|
+
|
|
905
|
+
### Examples
|
|
906
|
+
|
|
907
|
+
```ruby
|
|
908
|
+
require 'time'
|
|
909
|
+
require 'ionoscloud'
|
|
910
|
+
# setup authorization
|
|
911
|
+
Ionoscloud.configure do |config|
|
|
912
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
913
|
+
config.username = 'YOUR USERNAME'
|
|
914
|
+
config.password = 'YOUR PASSWORD'
|
|
915
|
+
|
|
916
|
+
# Configure API key authorization: Token Authentication
|
|
917
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
918
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
919
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
920
|
+
end
|
|
921
|
+
|
|
922
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
923
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
924
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
925
|
+
opts = {
|
|
926
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
927
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
928
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
929
|
+
}
|
|
930
|
+
|
|
931
|
+
begin
|
|
932
|
+
# Reboot servers
|
|
933
|
+
api_instance.datacenters_servers_reboot_post(datacenter_id, server_id, opts)
|
|
934
|
+
rescue Ionoscloud::ApiError => e
|
|
935
|
+
puts "Error when calling ServersApi->datacenters_servers_reboot_post: #{e}"
|
|
936
|
+
end
|
|
937
|
+
```
|
|
938
|
+
|
|
939
|
+
#### Using the datacenters_servers_reboot_post_with_http_info variant
|
|
940
|
+
|
|
941
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
942
|
+
|
|
943
|
+
> <Array(nil, Integer, Hash)> datacenters_servers_reboot_post_with_http_info(datacenter_id, server_id, opts)
|
|
944
|
+
|
|
945
|
+
```ruby
|
|
946
|
+
begin
|
|
947
|
+
# Reboot servers
|
|
948
|
+
data, status_code, headers = api_instance.datacenters_servers_reboot_post_with_http_info(datacenter_id, server_id, opts)
|
|
949
|
+
p status_code # => 2xx
|
|
950
|
+
p headers # => { ... }
|
|
951
|
+
p data # => nil
|
|
952
|
+
rescue Ionoscloud::ApiError => e
|
|
953
|
+
puts "Error when calling ServersApi->datacenters_servers_reboot_post_with_http_info: #{e}"
|
|
954
|
+
end
|
|
955
|
+
```
|
|
956
|
+
|
|
957
|
+
### Parameters
|
|
958
|
+
|
|
959
|
+
| Name | Type | Description | Notes |
|
|
960
|
+
| ---- | ---- | ----------- | ----- |
|
|
961
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
962
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
963
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
964
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
965
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
966
|
+
|
|
967
|
+
### Return type
|
|
968
|
+
|
|
969
|
+
nil (empty response body)
|
|
970
|
+
|
|
971
|
+
### Authorization
|
|
972
|
+
|
|
973
|
+
Basic Authentication, Token Authentication
|
|
974
|
+
|
|
975
|
+
### HTTP request headers
|
|
976
|
+
|
|
977
|
+
- **Content-Type**: Not defined
|
|
978
|
+
- **Accept**: application/json
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
## datacenters_servers_remote_console_get
|
|
982
|
+
|
|
983
|
+
> <RemoteConsoleUrl> datacenters_servers_remote_console_get(datacenter_id, server_id, opts)
|
|
984
|
+
|
|
985
|
+
Get Remote Console link
|
|
986
|
+
|
|
987
|
+
Retrieve a link with a JSON Web Token for accessing the server's Remote Console.
|
|
988
|
+
|
|
989
|
+
### Examples
|
|
990
|
+
|
|
991
|
+
```ruby
|
|
992
|
+
require 'time'
|
|
993
|
+
require 'ionoscloud'
|
|
994
|
+
# setup authorization
|
|
995
|
+
Ionoscloud.configure do |config|
|
|
996
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
997
|
+
config.username = 'YOUR USERNAME'
|
|
998
|
+
config.password = 'YOUR PASSWORD'
|
|
999
|
+
|
|
1000
|
+
# Configure API key authorization: Token Authentication
|
|
1001
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1002
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1003
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1004
|
+
end
|
|
1005
|
+
|
|
1006
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1007
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1008
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1009
|
+
opts = {
|
|
1010
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1011
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1012
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1013
|
+
}
|
|
1014
|
+
|
|
1015
|
+
begin
|
|
1016
|
+
# Get Remote Console link
|
|
1017
|
+
result = api_instance.datacenters_servers_remote_console_get(datacenter_id, server_id, opts)
|
|
1018
|
+
p result
|
|
1019
|
+
rescue Ionoscloud::ApiError => e
|
|
1020
|
+
puts "Error when calling ServersApi->datacenters_servers_remote_console_get: #{e}"
|
|
1021
|
+
end
|
|
1022
|
+
```
|
|
1023
|
+
|
|
1024
|
+
#### Using the datacenters_servers_remote_console_get_with_http_info variant
|
|
1025
|
+
|
|
1026
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1027
|
+
|
|
1028
|
+
> <Array(<RemoteConsoleUrl>, Integer, Hash)> datacenters_servers_remote_console_get_with_http_info(datacenter_id, server_id, opts)
|
|
1029
|
+
|
|
1030
|
+
```ruby
|
|
1031
|
+
begin
|
|
1032
|
+
# Get Remote Console link
|
|
1033
|
+
data, status_code, headers = api_instance.datacenters_servers_remote_console_get_with_http_info(datacenter_id, server_id, opts)
|
|
1034
|
+
p status_code # => 2xx
|
|
1035
|
+
p headers # => { ... }
|
|
1036
|
+
p data # => <RemoteConsoleUrl>
|
|
1037
|
+
rescue Ionoscloud::ApiError => e
|
|
1038
|
+
puts "Error when calling ServersApi->datacenters_servers_remote_console_get_with_http_info: #{e}"
|
|
1039
|
+
end
|
|
1040
|
+
```
|
|
1041
|
+
|
|
1042
|
+
### Parameters
|
|
1043
|
+
|
|
1044
|
+
| Name | Type | Description | Notes |
|
|
1045
|
+
| ---- | ---- | ----------- | ----- |
|
|
1046
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1047
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1048
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1049
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1050
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1051
|
+
|
|
1052
|
+
### Return type
|
|
1053
|
+
|
|
1054
|
+
[**RemoteConsoleUrl**](../models/RemoteConsoleUrl.md)
|
|
1055
|
+
|
|
1056
|
+
### Authorization
|
|
1057
|
+
|
|
1058
|
+
Basic Authentication, Token Authentication
|
|
1059
|
+
|
|
1060
|
+
### HTTP request headers
|
|
1061
|
+
|
|
1062
|
+
- **Content-Type**: Not defined
|
|
1063
|
+
- **Accept**: application/json
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
## datacenters_servers_resume_post
|
|
1067
|
+
|
|
1068
|
+
> datacenters_servers_resume_post(datacenter_id, server_id, opts)
|
|
1069
|
+
|
|
1070
|
+
Resume Cubes instances
|
|
1071
|
+
|
|
1072
|
+
Resume a suspended Cube instance; no billing event will be generated. This operation is only supported for the Cubes.
|
|
1073
|
+
|
|
1074
|
+
### Examples
|
|
1075
|
+
|
|
1076
|
+
```ruby
|
|
1077
|
+
require 'time'
|
|
1078
|
+
require 'ionoscloud'
|
|
1079
|
+
# setup authorization
|
|
1080
|
+
Ionoscloud.configure do |config|
|
|
1081
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1082
|
+
config.username = 'YOUR USERNAME'
|
|
1083
|
+
config.password = 'YOUR PASSWORD'
|
|
1084
|
+
|
|
1085
|
+
# Configure API key authorization: Token Authentication
|
|
1086
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1087
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1088
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1089
|
+
end
|
|
1090
|
+
|
|
1091
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1092
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1093
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1094
|
+
opts = {
|
|
1095
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1096
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1097
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1098
|
+
}
|
|
1099
|
+
|
|
1100
|
+
begin
|
|
1101
|
+
# Resume Cubes instances
|
|
1102
|
+
api_instance.datacenters_servers_resume_post(datacenter_id, server_id, opts)
|
|
1103
|
+
rescue Ionoscloud::ApiError => e
|
|
1104
|
+
puts "Error when calling ServersApi->datacenters_servers_resume_post: #{e}"
|
|
1105
|
+
end
|
|
1106
|
+
```
|
|
1107
|
+
|
|
1108
|
+
#### Using the datacenters_servers_resume_post_with_http_info variant
|
|
1109
|
+
|
|
1110
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1111
|
+
|
|
1112
|
+
> <Array(nil, Integer, Hash)> datacenters_servers_resume_post_with_http_info(datacenter_id, server_id, opts)
|
|
1113
|
+
|
|
1114
|
+
```ruby
|
|
1115
|
+
begin
|
|
1116
|
+
# Resume Cubes instances
|
|
1117
|
+
data, status_code, headers = api_instance.datacenters_servers_resume_post_with_http_info(datacenter_id, server_id, opts)
|
|
1118
|
+
p status_code # => 2xx
|
|
1119
|
+
p headers # => { ... }
|
|
1120
|
+
p data # => nil
|
|
1121
|
+
rescue Ionoscloud::ApiError => e
|
|
1122
|
+
puts "Error when calling ServersApi->datacenters_servers_resume_post_with_http_info: #{e}"
|
|
1123
|
+
end
|
|
1124
|
+
```
|
|
1125
|
+
|
|
1126
|
+
### Parameters
|
|
1127
|
+
|
|
1128
|
+
| Name | Type | Description | Notes |
|
|
1129
|
+
| ---- | ---- | ----------- | ----- |
|
|
1130
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1131
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1132
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1133
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1134
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1135
|
+
|
|
1136
|
+
### Return type
|
|
1137
|
+
|
|
1138
|
+
nil (empty response body)
|
|
1139
|
+
|
|
1140
|
+
### Authorization
|
|
1141
|
+
|
|
1142
|
+
Basic Authentication, Token Authentication
|
|
1143
|
+
|
|
1144
|
+
### HTTP request headers
|
|
1145
|
+
|
|
1146
|
+
- **Content-Type**: Not defined
|
|
1147
|
+
- **Accept**: application/json
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
## datacenters_servers_start_post
|
|
1151
|
+
|
|
1152
|
+
> datacenters_servers_start_post(datacenter_id, server_id, opts)
|
|
1153
|
+
|
|
1154
|
+
Start servers
|
|
1155
|
+
|
|
1156
|
+
Start the specified server within the data center; if the server's public IP address has been deallocated, a new IP address will be assigned.
|
|
1157
|
+
|
|
1158
|
+
### Examples
|
|
1159
|
+
|
|
1160
|
+
```ruby
|
|
1161
|
+
require 'time'
|
|
1162
|
+
require 'ionoscloud'
|
|
1163
|
+
# setup authorization
|
|
1164
|
+
Ionoscloud.configure do |config|
|
|
1165
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1166
|
+
config.username = 'YOUR USERNAME'
|
|
1167
|
+
config.password = 'YOUR PASSWORD'
|
|
1168
|
+
|
|
1169
|
+
# Configure API key authorization: Token Authentication
|
|
1170
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1171
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1172
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1173
|
+
end
|
|
1174
|
+
|
|
1175
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1176
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1177
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1178
|
+
opts = {
|
|
1179
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1180
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1181
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1182
|
+
}
|
|
1183
|
+
|
|
1184
|
+
begin
|
|
1185
|
+
# Start servers
|
|
1186
|
+
api_instance.datacenters_servers_start_post(datacenter_id, server_id, opts)
|
|
1187
|
+
rescue Ionoscloud::ApiError => e
|
|
1188
|
+
puts "Error when calling ServersApi->datacenters_servers_start_post: #{e}"
|
|
1189
|
+
end
|
|
1190
|
+
```
|
|
1191
|
+
|
|
1192
|
+
#### Using the datacenters_servers_start_post_with_http_info variant
|
|
1193
|
+
|
|
1194
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1195
|
+
|
|
1196
|
+
> <Array(nil, Integer, Hash)> datacenters_servers_start_post_with_http_info(datacenter_id, server_id, opts)
|
|
1197
|
+
|
|
1198
|
+
```ruby
|
|
1199
|
+
begin
|
|
1200
|
+
# Start servers
|
|
1201
|
+
data, status_code, headers = api_instance.datacenters_servers_start_post_with_http_info(datacenter_id, server_id, opts)
|
|
1202
|
+
p status_code # => 2xx
|
|
1203
|
+
p headers # => { ... }
|
|
1204
|
+
p data # => nil
|
|
1205
|
+
rescue Ionoscloud::ApiError => e
|
|
1206
|
+
puts "Error when calling ServersApi->datacenters_servers_start_post_with_http_info: #{e}"
|
|
1207
|
+
end
|
|
1208
|
+
```
|
|
1209
|
+
|
|
1210
|
+
### Parameters
|
|
1211
|
+
|
|
1212
|
+
| Name | Type | Description | Notes |
|
|
1213
|
+
| ---- | ---- | ----------- | ----- |
|
|
1214
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1215
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1216
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1217
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1218
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1219
|
+
|
|
1220
|
+
### Return type
|
|
1221
|
+
|
|
1222
|
+
nil (empty response body)
|
|
1223
|
+
|
|
1224
|
+
### Authorization
|
|
1225
|
+
|
|
1226
|
+
Basic Authentication, Token Authentication
|
|
1227
|
+
|
|
1228
|
+
### HTTP request headers
|
|
1229
|
+
|
|
1230
|
+
- **Content-Type**: Not defined
|
|
1231
|
+
- **Accept**: application/json
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
## datacenters_servers_stop_post
|
|
1235
|
+
|
|
1236
|
+
> datacenters_servers_stop_post(datacenter_id, server_id, opts)
|
|
1237
|
+
|
|
1238
|
+
Stop VMs
|
|
1239
|
+
|
|
1240
|
+
Stop the specified server within the data center: the VM will be forcefully shut down, the billing will cease, and any allocated public IPs will be deallocated. This operation is not supported for the Cubes.
|
|
1241
|
+
|
|
1242
|
+
### Examples
|
|
1243
|
+
|
|
1244
|
+
```ruby
|
|
1245
|
+
require 'time'
|
|
1246
|
+
require 'ionoscloud'
|
|
1247
|
+
# setup authorization
|
|
1248
|
+
Ionoscloud.configure do |config|
|
|
1249
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1250
|
+
config.username = 'YOUR USERNAME'
|
|
1251
|
+
config.password = 'YOUR PASSWORD'
|
|
1252
|
+
|
|
1253
|
+
# Configure API key authorization: Token Authentication
|
|
1254
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1255
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1256
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1257
|
+
end
|
|
1258
|
+
|
|
1259
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1260
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1261
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1262
|
+
opts = {
|
|
1263
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1264
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1265
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1266
|
+
}
|
|
1267
|
+
|
|
1268
|
+
begin
|
|
1269
|
+
# Stop VMs
|
|
1270
|
+
api_instance.datacenters_servers_stop_post(datacenter_id, server_id, opts)
|
|
1271
|
+
rescue Ionoscloud::ApiError => e
|
|
1272
|
+
puts "Error when calling ServersApi->datacenters_servers_stop_post: #{e}"
|
|
1273
|
+
end
|
|
1274
|
+
```
|
|
1275
|
+
|
|
1276
|
+
#### Using the datacenters_servers_stop_post_with_http_info variant
|
|
1277
|
+
|
|
1278
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1279
|
+
|
|
1280
|
+
> <Array(nil, Integer, Hash)> datacenters_servers_stop_post_with_http_info(datacenter_id, server_id, opts)
|
|
1281
|
+
|
|
1282
|
+
```ruby
|
|
1283
|
+
begin
|
|
1284
|
+
# Stop VMs
|
|
1285
|
+
data, status_code, headers = api_instance.datacenters_servers_stop_post_with_http_info(datacenter_id, server_id, opts)
|
|
1286
|
+
p status_code # => 2xx
|
|
1287
|
+
p headers # => { ... }
|
|
1288
|
+
p data # => nil
|
|
1289
|
+
rescue Ionoscloud::ApiError => e
|
|
1290
|
+
puts "Error when calling ServersApi->datacenters_servers_stop_post_with_http_info: #{e}"
|
|
1291
|
+
end
|
|
1292
|
+
```
|
|
1293
|
+
|
|
1294
|
+
### Parameters
|
|
1295
|
+
|
|
1296
|
+
| Name | Type | Description | Notes |
|
|
1297
|
+
| ---- | ---- | ----------- | ----- |
|
|
1298
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1299
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1300
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1301
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1302
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1303
|
+
|
|
1304
|
+
### Return type
|
|
1305
|
+
|
|
1306
|
+
nil (empty response body)
|
|
1307
|
+
|
|
1308
|
+
### Authorization
|
|
1309
|
+
|
|
1310
|
+
Basic Authentication, Token Authentication
|
|
1311
|
+
|
|
1312
|
+
### HTTP request headers
|
|
1313
|
+
|
|
1314
|
+
- **Content-Type**: Not defined
|
|
1315
|
+
- **Accept**: application/json
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
## datacenters_servers_suspend_post
|
|
1319
|
+
|
|
1320
|
+
> datacenters_servers_suspend_post(datacenter_id, server_id, opts)
|
|
1321
|
+
|
|
1322
|
+
Suspend Cubes instances
|
|
1323
|
+
|
|
1324
|
+
Suspend the specified Cubes instance within the data center. The instance will not be deleted, and allocated resources will continue to be billed. This operation is only supported for the Cubes.
|
|
1325
|
+
|
|
1326
|
+
### Examples
|
|
1327
|
+
|
|
1328
|
+
```ruby
|
|
1329
|
+
require 'time'
|
|
1330
|
+
require 'ionoscloud'
|
|
1331
|
+
# setup authorization
|
|
1332
|
+
Ionoscloud.configure do |config|
|
|
1333
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1334
|
+
config.username = 'YOUR USERNAME'
|
|
1335
|
+
config.password = 'YOUR PASSWORD'
|
|
1336
|
+
|
|
1337
|
+
# Configure API key authorization: Token Authentication
|
|
1338
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1339
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1340
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1341
|
+
end
|
|
1342
|
+
|
|
1343
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1344
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1345
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1346
|
+
opts = {
|
|
1347
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1348
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1349
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1350
|
+
}
|
|
1351
|
+
|
|
1352
|
+
begin
|
|
1353
|
+
# Suspend Cubes instances
|
|
1354
|
+
api_instance.datacenters_servers_suspend_post(datacenter_id, server_id, opts)
|
|
1355
|
+
rescue Ionoscloud::ApiError => e
|
|
1356
|
+
puts "Error when calling ServersApi->datacenters_servers_suspend_post: #{e}"
|
|
1357
|
+
end
|
|
1358
|
+
```
|
|
1359
|
+
|
|
1360
|
+
#### Using the datacenters_servers_suspend_post_with_http_info variant
|
|
1361
|
+
|
|
1362
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1363
|
+
|
|
1364
|
+
> <Array(nil, Integer, Hash)> datacenters_servers_suspend_post_with_http_info(datacenter_id, server_id, opts)
|
|
1365
|
+
|
|
1366
|
+
```ruby
|
|
1367
|
+
begin
|
|
1368
|
+
# Suspend Cubes instances
|
|
1369
|
+
data, status_code, headers = api_instance.datacenters_servers_suspend_post_with_http_info(datacenter_id, server_id, opts)
|
|
1370
|
+
p status_code # => 2xx
|
|
1371
|
+
p headers # => { ... }
|
|
1372
|
+
p data # => nil
|
|
1373
|
+
rescue Ionoscloud::ApiError => e
|
|
1374
|
+
puts "Error when calling ServersApi->datacenters_servers_suspend_post_with_http_info: #{e}"
|
|
1375
|
+
end
|
|
1376
|
+
```
|
|
1377
|
+
|
|
1378
|
+
### Parameters
|
|
1379
|
+
|
|
1380
|
+
| Name | Type | Description | Notes |
|
|
1381
|
+
| ---- | ---- | ----------- | ----- |
|
|
1382
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1383
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1384
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1385
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1386
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1387
|
+
|
|
1388
|
+
### Return type
|
|
1389
|
+
|
|
1390
|
+
nil (empty response body)
|
|
1391
|
+
|
|
1392
|
+
### Authorization
|
|
1393
|
+
|
|
1394
|
+
Basic Authentication, Token Authentication
|
|
1395
|
+
|
|
1396
|
+
### HTTP request headers
|
|
1397
|
+
|
|
1398
|
+
- **Content-Type**: Not defined
|
|
1399
|
+
- **Accept**: application/json
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
## datacenters_servers_token_get
|
|
1403
|
+
|
|
1404
|
+
> <Token> datacenters_servers_token_get(datacenter_id, server_id, opts)
|
|
1405
|
+
|
|
1406
|
+
Get JASON Web Token
|
|
1407
|
+
|
|
1408
|
+
Retrieve a JSON Web Token from the server for use in login operations (such as accessing the server's console).
|
|
1409
|
+
|
|
1410
|
+
### Examples
|
|
1411
|
+
|
|
1412
|
+
```ruby
|
|
1413
|
+
require 'time'
|
|
1414
|
+
require 'ionoscloud'
|
|
1415
|
+
# setup authorization
|
|
1416
|
+
Ionoscloud.configure do |config|
|
|
1417
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1418
|
+
config.username = 'YOUR USERNAME'
|
|
1419
|
+
config.password = 'YOUR PASSWORD'
|
|
1420
|
+
|
|
1421
|
+
# Configure API key authorization: Token Authentication
|
|
1422
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1423
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1424
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1425
|
+
end
|
|
1426
|
+
|
|
1427
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1428
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1429
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1430
|
+
opts = {
|
|
1431
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1432
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1433
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1434
|
+
}
|
|
1435
|
+
|
|
1436
|
+
begin
|
|
1437
|
+
# Get JASON Web Token
|
|
1438
|
+
result = api_instance.datacenters_servers_token_get(datacenter_id, server_id, opts)
|
|
1439
|
+
p result
|
|
1440
|
+
rescue Ionoscloud::ApiError => e
|
|
1441
|
+
puts "Error when calling ServersApi->datacenters_servers_token_get: #{e}"
|
|
1442
|
+
end
|
|
1443
|
+
```
|
|
1444
|
+
|
|
1445
|
+
#### Using the datacenters_servers_token_get_with_http_info variant
|
|
1446
|
+
|
|
1447
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1448
|
+
|
|
1449
|
+
> <Array(<Token>, Integer, Hash)> datacenters_servers_token_get_with_http_info(datacenter_id, server_id, opts)
|
|
1450
|
+
|
|
1451
|
+
```ruby
|
|
1452
|
+
begin
|
|
1453
|
+
# Get JASON Web Token
|
|
1454
|
+
data, status_code, headers = api_instance.datacenters_servers_token_get_with_http_info(datacenter_id, server_id, opts)
|
|
1455
|
+
p status_code # => 2xx
|
|
1456
|
+
p headers # => { ... }
|
|
1457
|
+
p data # => <Token>
|
|
1458
|
+
rescue Ionoscloud::ApiError => e
|
|
1459
|
+
puts "Error when calling ServersApi->datacenters_servers_token_get_with_http_info: #{e}"
|
|
1460
|
+
end
|
|
1461
|
+
```
|
|
1462
|
+
|
|
1463
|
+
### Parameters
|
|
1464
|
+
|
|
1465
|
+
| Name | Type | Description | Notes |
|
|
1466
|
+
| ---- | ---- | ----------- | ----- |
|
|
1467
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1468
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1469
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1470
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1471
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1472
|
+
|
|
1473
|
+
### Return type
|
|
1474
|
+
|
|
1475
|
+
[**Token**](../models/Token.md)
|
|
1476
|
+
|
|
1477
|
+
### Authorization
|
|
1478
|
+
|
|
1479
|
+
Basic Authentication, Token Authentication
|
|
1480
|
+
|
|
1481
|
+
### HTTP request headers
|
|
1482
|
+
|
|
1483
|
+
- **Content-Type**: Not defined
|
|
1484
|
+
- **Accept**: application/json
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
## datacenters_servers_upgrade_post
|
|
1488
|
+
|
|
1489
|
+
> datacenters_servers_upgrade_post(datacenter_id, server_id, opts)
|
|
1490
|
+
|
|
1491
|
+
Upgrade servers
|
|
1492
|
+
|
|
1493
|
+
Upgrade the server version, if needed. To determine if an upgrade is available, execute the following call: '/datacenters/{datacenterId}/servers?upgradeNeeded=true'
|
|
1494
|
+
|
|
1495
|
+
### Examples
|
|
1496
|
+
|
|
1497
|
+
```ruby
|
|
1498
|
+
require 'time'
|
|
1499
|
+
require 'ionoscloud'
|
|
1500
|
+
# setup authorization
|
|
1501
|
+
Ionoscloud.configure do |config|
|
|
1502
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1503
|
+
config.username = 'YOUR USERNAME'
|
|
1504
|
+
config.password = 'YOUR PASSWORD'
|
|
1505
|
+
|
|
1506
|
+
# Configure API key authorization: Token Authentication
|
|
1507
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1508
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1509
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1510
|
+
end
|
|
1511
|
+
|
|
1512
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1513
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1514
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1515
|
+
opts = {
|
|
1516
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1517
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1518
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1519
|
+
}
|
|
1520
|
+
|
|
1521
|
+
begin
|
|
1522
|
+
# Upgrade servers
|
|
1523
|
+
api_instance.datacenters_servers_upgrade_post(datacenter_id, server_id, opts)
|
|
1524
|
+
rescue Ionoscloud::ApiError => e
|
|
1525
|
+
puts "Error when calling ServersApi->datacenters_servers_upgrade_post: #{e}"
|
|
1526
|
+
end
|
|
1527
|
+
```
|
|
1528
|
+
|
|
1529
|
+
#### Using the datacenters_servers_upgrade_post_with_http_info variant
|
|
1530
|
+
|
|
1531
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1532
|
+
|
|
1533
|
+
> <Array(nil, Integer, Hash)> datacenters_servers_upgrade_post_with_http_info(datacenter_id, server_id, opts)
|
|
1534
|
+
|
|
1535
|
+
```ruby
|
|
1536
|
+
begin
|
|
1537
|
+
# Upgrade servers
|
|
1538
|
+
data, status_code, headers = api_instance.datacenters_servers_upgrade_post_with_http_info(datacenter_id, server_id, opts)
|
|
1539
|
+
p status_code # => 2xx
|
|
1540
|
+
p headers # => { ... }
|
|
1541
|
+
p data # => nil
|
|
1542
|
+
rescue Ionoscloud::ApiError => e
|
|
1543
|
+
puts "Error when calling ServersApi->datacenters_servers_upgrade_post_with_http_info: #{e}"
|
|
1544
|
+
end
|
|
1545
|
+
```
|
|
1546
|
+
|
|
1547
|
+
### Parameters
|
|
1548
|
+
|
|
1549
|
+
| Name | Type | Description | Notes |
|
|
1550
|
+
| ---- | ---- | ----------- | ----- |
|
|
1551
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1552
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1553
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1554
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1555
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1556
|
+
|
|
1557
|
+
### Return type
|
|
1558
|
+
|
|
1559
|
+
nil (empty response body)
|
|
1560
|
+
|
|
1561
|
+
### Authorization
|
|
1562
|
+
|
|
1563
|
+
Basic Authentication, Token Authentication
|
|
1564
|
+
|
|
1565
|
+
### HTTP request headers
|
|
1566
|
+
|
|
1567
|
+
- **Content-Type**: Not defined
|
|
1568
|
+
- **Accept**: application/json
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
## datacenters_servers_volumes_delete
|
|
1572
|
+
|
|
1573
|
+
> datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, opts)
|
|
1574
|
+
|
|
1575
|
+
Detach volumes
|
|
1576
|
+
|
|
1577
|
+
Detach the specified volume from the server without deleting it from the data center. A separate request must be made to perform the deletion.
|
|
1578
|
+
|
|
1579
|
+
### Examples
|
|
1580
|
+
|
|
1581
|
+
```ruby
|
|
1582
|
+
require 'time'
|
|
1583
|
+
require 'ionoscloud'
|
|
1584
|
+
# setup authorization
|
|
1585
|
+
Ionoscloud.configure do |config|
|
|
1586
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1587
|
+
config.username = 'YOUR USERNAME'
|
|
1588
|
+
config.password = 'YOUR PASSWORD'
|
|
1589
|
+
|
|
1590
|
+
# Configure API key authorization: Token Authentication
|
|
1591
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1592
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1593
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1594
|
+
end
|
|
1595
|
+
|
|
1596
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1597
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1598
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1599
|
+
volume_id = 'volume_id_example' # String | The unique ID of the volume.
|
|
1600
|
+
opts = {
|
|
1601
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1602
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1603
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1604
|
+
}
|
|
1605
|
+
|
|
1606
|
+
begin
|
|
1607
|
+
# Detach volumes
|
|
1608
|
+
api_instance.datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, opts)
|
|
1609
|
+
rescue Ionoscloud::ApiError => e
|
|
1610
|
+
puts "Error when calling ServersApi->datacenters_servers_volumes_delete: #{e}"
|
|
1611
|
+
end
|
|
1612
|
+
```
|
|
1613
|
+
|
|
1614
|
+
#### Using the datacenters_servers_volumes_delete_with_http_info variant
|
|
1615
|
+
|
|
1616
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1617
|
+
|
|
1618
|
+
> <Array(nil, Integer, Hash)> datacenters_servers_volumes_delete_with_http_info(datacenter_id, server_id, volume_id, opts)
|
|
1619
|
+
|
|
1620
|
+
```ruby
|
|
1621
|
+
begin
|
|
1622
|
+
# Detach volumes
|
|
1623
|
+
data, status_code, headers = api_instance.datacenters_servers_volumes_delete_with_http_info(datacenter_id, server_id, volume_id, opts)
|
|
1624
|
+
p status_code # => 2xx
|
|
1625
|
+
p headers # => { ... }
|
|
1626
|
+
p data # => nil
|
|
1627
|
+
rescue Ionoscloud::ApiError => e
|
|
1628
|
+
puts "Error when calling ServersApi->datacenters_servers_volumes_delete_with_http_info: #{e}"
|
|
1629
|
+
end
|
|
1630
|
+
```
|
|
1631
|
+
|
|
1632
|
+
### Parameters
|
|
1633
|
+
|
|
1634
|
+
| Name | Type | Description | Notes |
|
|
1635
|
+
| ---- | ---- | ----------- | ----- |
|
|
1636
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1637
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1638
|
+
| **volume_id** | **String** | The unique ID of the volume. | |
|
|
1639
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1640
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1641
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1642
|
+
|
|
1643
|
+
### Return type
|
|
1644
|
+
|
|
1645
|
+
nil (empty response body)
|
|
1646
|
+
|
|
1647
|
+
### Authorization
|
|
1648
|
+
|
|
1649
|
+
Basic Authentication, Token Authentication
|
|
1650
|
+
|
|
1651
|
+
### HTTP request headers
|
|
1652
|
+
|
|
1653
|
+
- **Content-Type**: Not defined
|
|
1654
|
+
- **Accept**: application/json
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
## datacenters_servers_volumes_find_by_id
|
|
1658
|
+
|
|
1659
|
+
> <Volume> datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, opts)
|
|
1660
|
+
|
|
1661
|
+
Retrieve attached volumes
|
|
1662
|
+
|
|
1663
|
+
Retrieve the properties of the volume, attached to the specified server.
|
|
1664
|
+
|
|
1665
|
+
### Examples
|
|
1666
|
+
|
|
1667
|
+
```ruby
|
|
1668
|
+
require 'time'
|
|
1669
|
+
require 'ionoscloud'
|
|
1670
|
+
# setup authorization
|
|
1671
|
+
Ionoscloud.configure do |config|
|
|
1672
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1673
|
+
config.username = 'YOUR USERNAME'
|
|
1674
|
+
config.password = 'YOUR PASSWORD'
|
|
1675
|
+
|
|
1676
|
+
# Configure API key authorization: Token Authentication
|
|
1677
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1678
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1679
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1680
|
+
end
|
|
1681
|
+
|
|
1682
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1683
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1684
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1685
|
+
volume_id = 'volume_id_example' # String | The unique ID of the volume.
|
|
1686
|
+
opts = {
|
|
1687
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1688
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1689
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1690
|
+
}
|
|
1691
|
+
|
|
1692
|
+
begin
|
|
1693
|
+
# Retrieve attached volumes
|
|
1694
|
+
result = api_instance.datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, opts)
|
|
1695
|
+
p result
|
|
1696
|
+
rescue Ionoscloud::ApiError => e
|
|
1697
|
+
puts "Error when calling ServersApi->datacenters_servers_volumes_find_by_id: #{e}"
|
|
1698
|
+
end
|
|
1699
|
+
```
|
|
1700
|
+
|
|
1701
|
+
#### Using the datacenters_servers_volumes_find_by_id_with_http_info variant
|
|
1702
|
+
|
|
1703
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1704
|
+
|
|
1705
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_servers_volumes_find_by_id_with_http_info(datacenter_id, server_id, volume_id, opts)
|
|
1706
|
+
|
|
1707
|
+
```ruby
|
|
1708
|
+
begin
|
|
1709
|
+
# Retrieve attached volumes
|
|
1710
|
+
data, status_code, headers = api_instance.datacenters_servers_volumes_find_by_id_with_http_info(datacenter_id, server_id, volume_id, opts)
|
|
1711
|
+
p status_code # => 2xx
|
|
1712
|
+
p headers # => { ... }
|
|
1713
|
+
p data # => <Volume>
|
|
1714
|
+
rescue Ionoscloud::ApiError => e
|
|
1715
|
+
puts "Error when calling ServersApi->datacenters_servers_volumes_find_by_id_with_http_info: #{e}"
|
|
1716
|
+
end
|
|
1717
|
+
```
|
|
1718
|
+
|
|
1719
|
+
### Parameters
|
|
1720
|
+
|
|
1721
|
+
| Name | Type | Description | Notes |
|
|
1722
|
+
| ---- | ---- | ----------- | ----- |
|
|
1723
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1724
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1725
|
+
| **volume_id** | **String** | The unique ID of the volume. | |
|
|
1726
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1727
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1728
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1729
|
+
|
|
1730
|
+
### Return type
|
|
1731
|
+
|
|
1732
|
+
[**Volume**](../models/Volume.md)
|
|
1733
|
+
|
|
1734
|
+
### Authorization
|
|
1735
|
+
|
|
1736
|
+
Basic Authentication, Token Authentication
|
|
1737
|
+
|
|
1738
|
+
### HTTP request headers
|
|
1739
|
+
|
|
1740
|
+
- **Content-Type**: Not defined
|
|
1741
|
+
- **Accept**: application/json
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
## datacenters_servers_volumes_get
|
|
1745
|
+
|
|
1746
|
+
> <AttachedVolumes> datacenters_servers_volumes_get(datacenter_id, server_id, opts)
|
|
1747
|
+
|
|
1748
|
+
List attached volumes
|
|
1749
|
+
|
|
1750
|
+
List all volumes, attached to the specified server.
|
|
1751
|
+
|
|
1752
|
+
### Examples
|
|
1753
|
+
|
|
1754
|
+
```ruby
|
|
1755
|
+
require 'time'
|
|
1756
|
+
require 'ionoscloud'
|
|
1757
|
+
# setup authorization
|
|
1758
|
+
Ionoscloud.configure do |config|
|
|
1759
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1760
|
+
config.username = 'YOUR USERNAME'
|
|
1761
|
+
config.password = 'YOUR PASSWORD'
|
|
1762
|
+
end
|
|
1763
|
+
|
|
1764
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1765
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1766
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1767
|
+
opts = {
|
|
1768
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1769
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1770
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1771
|
+
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
|
|
1772
|
+
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
|
|
1773
|
+
}
|
|
1774
|
+
|
|
1775
|
+
begin
|
|
1776
|
+
# List attached volumes
|
|
1777
|
+
result = api_instance.datacenters_servers_volumes_get(datacenter_id, server_id, opts)
|
|
1778
|
+
p result
|
|
1779
|
+
rescue Ionoscloud::ApiError => e
|
|
1780
|
+
puts "Error when calling ServersApi->datacenters_servers_volumes_get: #{e}"
|
|
1781
|
+
end
|
|
1782
|
+
```
|
|
1783
|
+
|
|
1784
|
+
#### Using the datacenters_servers_volumes_get_with_http_info variant
|
|
1785
|
+
|
|
1786
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1787
|
+
|
|
1788
|
+
> <Array(<AttachedVolumes>, Integer, Hash)> datacenters_servers_volumes_get_with_http_info(datacenter_id, server_id, opts)
|
|
1789
|
+
|
|
1790
|
+
```ruby
|
|
1791
|
+
begin
|
|
1792
|
+
# List attached volumes
|
|
1793
|
+
data, status_code, headers = api_instance.datacenters_servers_volumes_get_with_http_info(datacenter_id, server_id, opts)
|
|
1794
|
+
p status_code # => 2xx
|
|
1795
|
+
p headers # => { ... }
|
|
1796
|
+
p data # => <AttachedVolumes>
|
|
1797
|
+
rescue Ionoscloud::ApiError => e
|
|
1798
|
+
puts "Error when calling ServersApi->datacenters_servers_volumes_get_with_http_info: #{e}"
|
|
1799
|
+
end
|
|
1800
|
+
```
|
|
1801
|
+
|
|
1802
|
+
### Parameters
|
|
1803
|
+
|
|
1804
|
+
| Name | Type | Description | Notes |
|
|
1805
|
+
| ---- | ---- | ----------- | ----- |
|
|
1806
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1807
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1808
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1809
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1810
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1811
|
+
| **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). | [optional][default to 0] |
|
|
1812
|
+
| **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
|
|
1813
|
+
|
|
1814
|
+
### Return type
|
|
1815
|
+
|
|
1816
|
+
[**AttachedVolumes**](../models/AttachedVolumes.md)
|
|
1817
|
+
|
|
1818
|
+
### Authorization
|
|
1819
|
+
|
|
1820
|
+
Basic Authentication
|
|
1821
|
+
|
|
1822
|
+
### HTTP request headers
|
|
1823
|
+
|
|
1824
|
+
- **Content-Type**: Not defined
|
|
1825
|
+
- **Accept**: application/json
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
## datacenters_servers_volumes_post
|
|
1829
|
+
|
|
1830
|
+
> <Volume> datacenters_servers_volumes_post(datacenter_id, server_id, volume, opts)
|
|
1831
|
+
|
|
1832
|
+
Attach volumes
|
|
1833
|
+
|
|
1834
|
+
Attach an existing storage volume to the specified server. A volume scan also be created and attached in one step by providing the new volume description as payload. The combined total of attached volumes and NICs cannot exceed 24 per server.
|
|
1835
|
+
|
|
1836
|
+
### Examples
|
|
1837
|
+
|
|
1838
|
+
```ruby
|
|
1839
|
+
require 'time'
|
|
1840
|
+
require 'ionoscloud'
|
|
1841
|
+
# setup authorization
|
|
1842
|
+
Ionoscloud.configure do |config|
|
|
1843
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
1844
|
+
config.username = 'YOUR USERNAME'
|
|
1845
|
+
config.password = 'YOUR PASSWORD'
|
|
1846
|
+
end
|
|
1847
|
+
|
|
1848
|
+
api_instance = Ionoscloud::ServersApi.new
|
|
1849
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
1850
|
+
server_id = 'server_id_example' # String | The unique ID of the server.
|
|
1851
|
+
volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | The volume to be attached (or created and attached).
|
|
1852
|
+
opts = {
|
|
1853
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
1854
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
|
1855
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
|
1856
|
+
}
|
|
1857
|
+
|
|
1858
|
+
begin
|
|
1859
|
+
# Attach volumes
|
|
1860
|
+
result = api_instance.datacenters_servers_volumes_post(datacenter_id, server_id, volume, opts)
|
|
1861
|
+
p result
|
|
1862
|
+
rescue Ionoscloud::ApiError => e
|
|
1863
|
+
puts "Error when calling ServersApi->datacenters_servers_volumes_post: #{e}"
|
|
1864
|
+
end
|
|
1865
|
+
```
|
|
1866
|
+
|
|
1867
|
+
#### Using the datacenters_servers_volumes_post_with_http_info variant
|
|
1868
|
+
|
|
1869
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1870
|
+
|
|
1871
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_servers_volumes_post_with_http_info(datacenter_id, server_id, volume, opts)
|
|
1872
|
+
|
|
1873
|
+
```ruby
|
|
1874
|
+
begin
|
|
1875
|
+
# Attach volumes
|
|
1876
|
+
data, status_code, headers = api_instance.datacenters_servers_volumes_post_with_http_info(datacenter_id, server_id, volume, opts)
|
|
1877
|
+
p status_code # => 2xx
|
|
1878
|
+
p headers # => { ... }
|
|
1879
|
+
p data # => <Volume>
|
|
1880
|
+
rescue Ionoscloud::ApiError => e
|
|
1881
|
+
puts "Error when calling ServersApi->datacenters_servers_volumes_post_with_http_info: #{e}"
|
|
1882
|
+
end
|
|
1883
|
+
```
|
|
1884
|
+
|
|
1885
|
+
### Parameters
|
|
1886
|
+
|
|
1887
|
+
| Name | Type | Description | Notes |
|
|
1888
|
+
| ---- | ---- | ----------- | ----- |
|
|
1889
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
1890
|
+
| **server_id** | **String** | The unique ID of the server. | |
|
|
1891
|
+
| **volume** | [**Volume**](Volume.md) | The volume to be attached (or created and attached). | |
|
|
1892
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
1893
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
|
1894
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
|
1895
|
+
|
|
1896
|
+
### Return type
|
|
1897
|
+
|
|
1898
|
+
[**Volume**](../models/Volume.md)
|
|
1899
|
+
|
|
1900
|
+
### Authorization
|
|
1901
|
+
|
|
1902
|
+
Basic Authentication
|
|
1903
|
+
|
|
1904
|
+
### HTTP request headers
|
|
1905
|
+
|
|
1906
|
+
- **Content-Type**: application/json
|
|
1907
|
+
- **Accept**: application/json
|
|
1908
|
+
|