ionoscloud 6.0.0.beta.3 → 6.0.0.beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE +190 -0
- data/docs/{BackupUnitsApi.md → api/BackupUnitsApi.md} +40 -40
- data/docs/{ContractResourcesApi.md → api/ContractResourcesApi.md} +6 -6
- data/docs/api/DataCentersApi.md +516 -0
- data/docs/api/DefaultApi.md +78 -0
- data/docs/{FirewallRulesApi.md → api/FirewallRulesApi.md} +52 -52
- data/docs/{FlowLogsApi.md → api/FlowLogsApi.md} +40 -40
- data/docs/{IPBlocksApi.md → api/IPBlocksApi.md} +40 -36
- data/docs/{ImagesApi.md → api/ImagesApi.md} +30 -30
- data/docs/{KubernetesApi.md → api/KubernetesApi.md} +98 -98
- data/docs/{LabelsApi.md → api/LabelsApi.md} +182 -190
- data/docs/{LansApi.md → api/LansApi.md} +80 -80
- data/docs/{LoadBalancersApi.md → api/LoadBalancersApi.md} +84 -92
- data/docs/{LocationsApi.md → api/LocationsApi.md} +32 -32
- data/docs/{NATGatewaysApi.md → api/NATGatewaysApi.md} +136 -140
- data/docs/{NetworkInterfacesApi.md → api/NetworkInterfacesApi.md} +52 -52
- data/docs/{NetworkLoadBalancersApi.md → api/NetworkLoadBalancersApi.md} +151 -155
- data/docs/{PrivateCrossConnectsApi.md → api/PrivateCrossConnectsApi.md} +31 -35
- data/docs/{RequestsApi.md → api/RequestsApi.md} +22 -22
- data/docs/{ServersApi.md → api/ServersApi.md} +188 -188
- data/docs/{SnapshotsApi.md → api/SnapshotsApi.md} +30 -30
- data/docs/{TemplatesApi.md → api/TemplatesApi.md} +4 -4
- data/docs/{UserManagementApi.md → api/UserManagementApi.md} +148 -144
- data/docs/{UserS3KeysApi.md → api/UserS3KeysApi.md} +34 -34
- data/docs/{VolumesApi.md → api/VolumesApi.md} +68 -68
- data/docs/{AttachedVolumes.md → models/AttachedVolumes.md} +0 -0
- data/docs/{BackupUnit.md → models/BackupUnit.md} +0 -0
- data/docs/{BackupUnitProperties.md → models/BackupUnitProperties.md} +0 -0
- data/docs/{BackupUnitSSO.md → models/BackupUnitSSO.md} +0 -0
- data/docs/{BackupUnits.md → models/BackupUnits.md} +0 -0
- data/docs/{BalancedNics.md → models/BalancedNics.md} +0 -0
- data/docs/{Cdroms.md → models/Cdroms.md} +0 -0
- data/docs/{ConnectableDatacenter.md → models/ConnectableDatacenter.md} +0 -0
- data/docs/{Contract.md → models/Contract.md} +0 -0
- data/docs/{ContractProperties.md → models/ContractProperties.md} +0 -0
- data/docs/{Contracts.md → models/Contracts.md} +0 -0
- data/docs/{CpuArchitectureProperties.md → models/CpuArchitectureProperties.md} +0 -0
- data/docs/{DataCenterEntities.md → models/DataCenterEntities.md} +0 -0
- data/docs/{Datacenter.md → models/Datacenter.md} +0 -0
- data/docs/{DatacenterElementMetadata.md → models/DatacenterElementMetadata.md} +0 -0
- data/docs/{DatacenterProperties.md → models/DatacenterProperties.md} +0 -0
- data/docs/{Datacenters.md → models/Datacenters.md} +0 -0
- data/docs/{Error.md → models/Error.md} +0 -0
- data/docs/{ErrorMessage.md → models/ErrorMessage.md} +0 -0
- data/docs/{FirewallRule.md → models/FirewallRule.md} +0 -0
- data/docs/{FirewallRules.md → models/FirewallRules.md} +0 -0
- data/docs/{FirewallruleProperties.md → models/FirewallruleProperties.md} +0 -0
- data/docs/{FlowLog.md → models/FlowLog.md} +0 -0
- data/docs/{FlowLogProperties.md → models/FlowLogProperties.md} +0 -0
- data/docs/{FlowLogPut.md → models/FlowLogPut.md} +0 -0
- data/docs/{FlowLogs.md → models/FlowLogs.md} +0 -0
- data/docs/{Group.md → models/Group.md} +0 -0
- data/docs/{GroupEntities.md → models/GroupEntities.md} +0 -0
- data/docs/{GroupMembers.md → models/GroupMembers.md} +0 -0
- data/docs/{GroupProperties.md → models/GroupProperties.md} +0 -0
- data/docs/{GroupShare.md → models/GroupShare.md} +0 -0
- data/docs/{GroupShareProperties.md → models/GroupShareProperties.md} +0 -0
- data/docs/{GroupShares.md → models/GroupShares.md} +0 -0
- data/docs/{GroupUsers.md → models/GroupUsers.md} +0 -0
- data/docs/{Groups.md → models/Groups.md} +0 -0
- data/docs/{IPFailover.md → models/IPFailover.md} +0 -0
- data/docs/{Image.md → models/Image.md} +0 -0
- data/docs/{ImageProperties.md → models/ImageProperties.md} +0 -0
- data/docs/{Images.md → models/Images.md} +0 -0
- data/docs/{Info.md → models/Info.md} +0 -0
- data/docs/{IpBlock.md → models/IpBlock.md} +0 -0
- data/docs/{IpBlockProperties.md → models/IpBlockProperties.md} +0 -0
- data/docs/{IpBlocks.md → models/IpBlocks.md} +7 -1
- data/docs/{IpConsumer.md → models/IpConsumer.md} +0 -0
- data/docs/{KubernetesAutoScaling.md → models/KubernetesAutoScaling.md} +0 -0
- data/docs/{KubernetesCluster.md → models/KubernetesCluster.md} +0 -0
- data/docs/{KubernetesClusterEntities.md → models/KubernetesClusterEntities.md} +0 -0
- data/docs/{KubernetesClusterForPost.md → models/KubernetesClusterForPost.md} +0 -0
- data/docs/{KubernetesClusterForPut.md → models/KubernetesClusterForPut.md} +0 -0
- data/docs/{KubernetesClusterProperties.md → models/KubernetesClusterProperties.md} +4 -2
- data/docs/{KubernetesClusterPropertiesForPost.md → models/KubernetesClusterPropertiesForPost.md} +4 -2
- data/docs/{KubernetesClusterPropertiesForPut.md → models/KubernetesClusterPropertiesForPut.md} +5 -1
- data/docs/{KubernetesClusters.md → models/KubernetesClusters.md} +0 -0
- data/docs/{KubernetesMaintenanceWindow.md → models/KubernetesMaintenanceWindow.md} +0 -0
- data/docs/{KubernetesNode.md → models/KubernetesNode.md} +0 -0
- data/docs/{KubernetesNodeMetadata.md → models/KubernetesNodeMetadata.md} +0 -0
- data/docs/{KubernetesNodePool.md → models/KubernetesNodePool.md} +0 -0
- data/docs/{KubernetesNodePoolForPost.md → models/KubernetesNodePoolForPost.md} +0 -0
- data/docs/{KubernetesNodePoolForPut.md → models/KubernetesNodePoolForPut.md} +0 -0
- data/docs/{KubernetesNodePoolLan.md → models/KubernetesNodePoolLan.md} +1 -1
- data/docs/{KubernetesNodePoolLanRoutes.md → models/KubernetesNodePoolLanRoutes.md} +0 -0
- data/docs/{KubernetesNodePoolProperties.md → models/KubernetesNodePoolProperties.md} +3 -1
- data/docs/{KubernetesNodePoolPropertiesForPost.md → models/KubernetesNodePoolPropertiesForPost.md} +3 -1
- data/docs/{KubernetesNodePoolPropertiesForPut.md → models/KubernetesNodePoolPropertiesForPut.md} +0 -0
- data/docs/{KubernetesNodePools.md → models/KubernetesNodePools.md} +0 -0
- data/docs/{KubernetesNodeProperties.md → models/KubernetesNodeProperties.md} +0 -0
- data/docs/{KubernetesNodes.md → models/KubernetesNodes.md} +0 -0
- data/docs/{Label.md → models/Label.md} +0 -0
- data/docs/{LabelProperties.md → models/LabelProperties.md} +0 -0
- data/docs/{LabelResource.md → models/LabelResource.md} +0 -0
- data/docs/{LabelResourceProperties.md → models/LabelResourceProperties.md} +0 -0
- data/docs/{LabelResources.md → models/LabelResources.md} +0 -0
- data/docs/{Labels.md → models/Labels.md} +0 -0
- data/docs/{Lan.md → models/Lan.md} +0 -0
- data/docs/{LanEntities.md → models/LanEntities.md} +0 -0
- data/docs/{LanNics.md → models/LanNics.md} +0 -0
- data/docs/{LanPost.md → models/LanPost.md} +0 -0
- data/docs/{LanProperties.md → models/LanProperties.md} +0 -0
- data/docs/{LanPropertiesPost.md → models/LanPropertiesPost.md} +0 -0
- data/docs/{Lans.md → models/Lans.md} +0 -0
- data/docs/{Loadbalancer.md → models/Loadbalancer.md} +0 -0
- data/docs/{LoadbalancerEntities.md → models/LoadbalancerEntities.md} +0 -0
- data/docs/{LoadbalancerProperties.md → models/LoadbalancerProperties.md} +0 -0
- data/docs/{Loadbalancers.md → models/Loadbalancers.md} +0 -0
- data/docs/{Location.md → models/Location.md} +0 -0
- data/docs/{LocationProperties.md → models/LocationProperties.md} +0 -0
- data/docs/{Locations.md → models/Locations.md} +0 -0
- data/docs/{NatGateway.md → models/NatGateway.md} +0 -0
- data/docs/{NatGatewayEntities.md → models/NatGatewayEntities.md} +0 -0
- data/docs/{NatGatewayLanProperties.md → models/NatGatewayLanProperties.md} +0 -0
- data/docs/{NatGatewayProperties.md → models/NatGatewayProperties.md} +0 -0
- data/docs/{NatGatewayPut.md → models/NatGatewayPut.md} +0 -0
- data/docs/{NatGatewayRule.md → models/NatGatewayRule.md} +0 -0
- data/docs/{NatGatewayRuleProperties.md → models/NatGatewayRuleProperties.md} +0 -0
- data/docs/{NatGatewayRuleProtocol.md → models/NatGatewayRuleProtocol.md} +0 -0
- data/docs/{NatGatewayRulePut.md → models/NatGatewayRulePut.md} +0 -0
- data/docs/{NatGatewayRuleType.md → models/NatGatewayRuleType.md} +0 -0
- data/docs/{NatGatewayRules.md → models/NatGatewayRules.md} +0 -0
- data/docs/{NatGateways.md → models/NatGateways.md} +0 -0
- data/docs/{NetworkLoadBalancer.md → models/NetworkLoadBalancer.md} +0 -0
- data/docs/{NetworkLoadBalancerEntities.md → models/NetworkLoadBalancerEntities.md} +0 -0
- data/docs/{NetworkLoadBalancerForwardingRule.md → models/NetworkLoadBalancerForwardingRule.md} +0 -0
- data/docs/{NetworkLoadBalancerForwardingRuleHealthCheck.md → models/NetworkLoadBalancerForwardingRuleHealthCheck.md} +0 -2
- data/docs/{NetworkLoadBalancerForwardingRuleProperties.md → models/NetworkLoadBalancerForwardingRuleProperties.md} +1 -1
- data/docs/{NetworkLoadBalancerForwardingRulePut.md → models/NetworkLoadBalancerForwardingRulePut.md} +0 -0
- 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} +0 -0
- data/docs/{NetworkLoadBalancerProperties.md → models/NetworkLoadBalancerProperties.md} +0 -0
- data/docs/{NetworkLoadBalancerPut.md → models/NetworkLoadBalancerPut.md} +0 -0
- data/docs/{NetworkLoadBalancers.md → models/NetworkLoadBalancers.md} +0 -0
- data/docs/{Nic.md → models/Nic.md} +0 -0
- data/docs/{NicEntities.md → models/NicEntities.md} +0 -0
- data/docs/{NicProperties.md → models/NicProperties.md} +0 -0
- data/docs/{NicPut.md → models/NicPut.md} +0 -0
- data/docs/{Nics.md → models/Nics.md} +0 -0
- data/docs/{NoStateMetaData.md → models/NoStateMetaData.md} +0 -0
- data/docs/{PaginationLinks.md → models/PaginationLinks.md} +0 -0
- data/docs/{Peer.md → models/Peer.md} +0 -0
- data/docs/{PrivateCrossConnect.md → models/PrivateCrossConnect.md} +0 -0
- data/docs/{PrivateCrossConnectProperties.md → models/PrivateCrossConnectProperties.md} +1 -1
- data/docs/{PrivateCrossConnects.md → models/PrivateCrossConnects.md} +0 -0
- data/docs/{RemoteConsoleUrl.md → models/RemoteConsoleUrl.md} +0 -0
- data/docs/{Request.md → models/Request.md} +0 -0
- data/docs/{RequestMetadata.md → models/RequestMetadata.md} +0 -0
- data/docs/{RequestProperties.md → models/RequestProperties.md} +0 -0
- data/docs/{RequestStatus.md → models/RequestStatus.md} +0 -0
- data/docs/{RequestStatusMetadata.md → models/RequestStatusMetadata.md} +0 -0
- data/docs/{RequestTarget.md → models/RequestTarget.md} +0 -0
- data/docs/{Requests.md → models/Requests.md} +1 -1
- data/docs/{Resource.md → models/Resource.md} +0 -0
- data/docs/{ResourceEntities.md → models/ResourceEntities.md} +0 -0
- data/docs/{ResourceGroups.md → models/ResourceGroups.md} +0 -0
- data/docs/{ResourceLimits.md → models/ResourceLimits.md} +0 -0
- data/docs/{ResourceProperties.md → models/ResourceProperties.md} +1 -1
- data/docs/{ResourceReference.md → models/ResourceReference.md} +0 -0
- data/docs/{Resources.md → models/Resources.md} +0 -0
- data/docs/{ResourcesUsers.md → models/ResourcesUsers.md} +0 -0
- data/docs/models/S3Bucket.md +18 -0
- data/docs/{S3Key.md → models/S3Key.md} +0 -0
- data/docs/{S3KeyMetadata.md → models/S3KeyMetadata.md} +0 -0
- data/docs/{S3KeyProperties.md → models/S3KeyProperties.md} +0 -0
- data/docs/{S3Keys.md → models/S3Keys.md} +0 -0
- data/docs/{S3ObjectStorageSSO.md → models/S3ObjectStorageSSO.md} +0 -0
- data/docs/{Server.md → models/Server.md} +0 -0
- data/docs/{ServerEntities.md → models/ServerEntities.md} +0 -0
- data/docs/{ServerProperties.md → models/ServerProperties.md} +0 -0
- data/docs/{Servers.md → models/Servers.md} +0 -0
- data/docs/{Snapshot.md → models/Snapshot.md} +0 -0
- data/docs/{SnapshotProperties.md → models/SnapshotProperties.md} +0 -0
- data/docs/{Snapshots.md → models/Snapshots.md} +0 -0
- data/docs/{TargetPortRange.md → models/TargetPortRange.md} +0 -0
- data/docs/{Template.md → models/Template.md} +0 -0
- data/docs/{TemplateProperties.md → models/TemplateProperties.md} +0 -0
- data/docs/{Templates.md → models/Templates.md} +0 -0
- data/docs/{Token.md → models/Token.md} +0 -0
- data/docs/{Type.md → models/Type.md} +0 -0
- data/docs/{User.md → models/User.md} +0 -0
- data/docs/{UserMetadata.md → models/UserMetadata.md} +0 -0
- data/docs/{UserPost.md → models/UserPost.md} +0 -0
- data/docs/{UserProperties.md → models/UserProperties.md} +0 -0
- data/docs/{UserPropertiesPost.md → models/UserPropertiesPost.md} +0 -0
- data/docs/{UserPropertiesPut.md → models/UserPropertiesPut.md} +0 -0
- data/docs/{UserPut.md → models/UserPut.md} +0 -0
- data/docs/models/Users.md +30 -0
- data/docs/{UsersEntities.md → models/UsersEntities.md} +0 -0
- data/docs/{Volume.md → models/Volume.md} +0 -0
- data/docs/{VolumeProperties.md → models/VolumeProperties.md} +2 -0
- data/docs/{Volumes.md → models/Volumes.md} +0 -0
- data/ionoscloud.gemspec +4 -4
- data/lib/ionoscloud/api/_api.rb +9 -9
- data/lib/ionoscloud/api/backup_units_api.rb +43 -43
- data/lib/ionoscloud/api/contract_resources_api.rb +9 -9
- data/lib/ionoscloud/api/data_centers_api.rb +81 -81
- data/lib/ionoscloud/api/firewall_rules_api.rb +55 -55
- data/lib/ionoscloud/api/flow_logs_api.rb +43 -43
- data/lib/ionoscloud/api/images_api.rb +33 -33
- data/lib/ionoscloud/api/ip_blocks_api.rb +57 -39
- data/lib/ionoscloud/api/kubernetes_api.rb +105 -105
- data/lib/ionoscloud/api/labels_api.rb +185 -221
- data/lib/ionoscloud/api/lans_api.rb +83 -83
- data/lib/ionoscloud/api/load_balancers_api.rb +87 -123
- data/lib/ionoscloud/api/locations_api.rb +31 -31
- data/lib/ionoscloud/api/nat_gateways_api.rb +139 -157
- data/lib/ionoscloud/api/network_interfaces_api.rb +55 -55
- data/lib/ionoscloud/api/network_load_balancers_api.rb +151 -169
- data/lib/ionoscloud/api/private_cross_connects_api.rb +35 -53
- data/lib/ionoscloud/api/requests_api.rb +25 -25
- data/lib/ionoscloud/api/servers_api.rb +191 -191
- data/lib/ionoscloud/api/snapshots_api.rb +33 -33
- data/lib/ionoscloud/api/templates_api.rb +7 -7
- data/lib/ionoscloud/api/user_management_api.rb +165 -147
- data/lib/ionoscloud/api/user_s3_keys_api.rb +37 -37
- data/lib/ionoscloud/api/volumes_api.rb +71 -71
- data/lib/ionoscloud/api_client.rb +8 -7
- data/lib/ionoscloud/api_error.rb +3 -3
- data/lib/ionoscloud/configuration.rb +3 -3
- data/lib/ionoscloud/models/attached_volumes.rb +5 -3
- data/lib/ionoscloud/models/backup_unit.rb +5 -3
- data/lib/ionoscloud/models/backup_unit_properties.rb +5 -3
- data/lib/ionoscloud/models/backup_unit_sso.rb +5 -3
- data/lib/ionoscloud/models/backup_units.rb +5 -3
- data/lib/ionoscloud/models/balanced_nics.rb +5 -3
- data/lib/ionoscloud/models/cdroms.rb +5 -3
- data/lib/ionoscloud/models/connectable_datacenter.rb +5 -3
- data/lib/ionoscloud/models/contract.rb +5 -3
- data/lib/ionoscloud/models/contract_properties.rb +5 -3
- data/lib/ionoscloud/models/contracts.rb +5 -3
- data/lib/ionoscloud/models/cpu_architecture_properties.rb +5 -3
- data/lib/ionoscloud/models/data_center_entities.rb +5 -3
- data/lib/ionoscloud/models/datacenter.rb +5 -3
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +5 -3
- data/lib/ionoscloud/models/datacenter_properties.rb +5 -3
- data/lib/ionoscloud/models/datacenters.rb +5 -3
- data/lib/ionoscloud/models/error.rb +5 -3
- data/lib/ionoscloud/models/error_message.rb +5 -3
- data/lib/ionoscloud/models/firewall_rule.rb +5 -3
- data/lib/ionoscloud/models/firewall_rules.rb +5 -3
- data/lib/ionoscloud/models/firewallrule_properties.rb +5 -3
- data/lib/ionoscloud/models/flow_log.rb +5 -3
- data/lib/ionoscloud/models/flow_log_properties.rb +5 -3
- data/lib/ionoscloud/models/flow_log_put.rb +5 -3
- data/lib/ionoscloud/models/flow_logs.rb +5 -3
- data/lib/ionoscloud/models/group.rb +5 -3
- data/lib/ionoscloud/models/group_entities.rb +5 -3
- data/lib/ionoscloud/models/group_members.rb +5 -3
- data/lib/ionoscloud/models/group_properties.rb +5 -3
- data/lib/ionoscloud/models/group_share.rb +5 -3
- data/lib/ionoscloud/models/group_share_properties.rb +5 -3
- data/lib/ionoscloud/models/group_shares.rb +5 -3
- data/lib/ionoscloud/models/group_users.rb +5 -3
- data/lib/ionoscloud/models/groups.rb +5 -3
- data/lib/ionoscloud/models/image.rb +5 -3
- data/lib/ionoscloud/models/image_properties.rb +7 -5
- data/lib/ionoscloud/models/images.rb +5 -3
- data/lib/ionoscloud/models/info.rb +5 -3
- data/lib/ionoscloud/models/ip_block.rb +5 -3
- data/lib/ionoscloud/models/ip_block_properties.rb +5 -3
- data/lib/ionoscloud/models/ip_blocks.rb +38 -7
- data/lib/ionoscloud/models/ip_consumer.rb +5 -3
- data/lib/ionoscloud/models/ip_failover.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_cluster.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +27 -11
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +27 -11
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +33 -7
- data/lib/ionoscloud/models/kubernetes_clusters.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_node.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_node_pool.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +10 -3
- data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +19 -7
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +19 -7
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_node_pools.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_node_properties.rb +5 -3
- data/lib/ionoscloud/models/kubernetes_nodes.rb +5 -3
- data/lib/ionoscloud/models/label.rb +5 -3
- data/lib/ionoscloud/models/label_properties.rb +5 -3
- data/lib/ionoscloud/models/label_resource.rb +5 -3
- data/lib/ionoscloud/models/label_resource_properties.rb +5 -3
- data/lib/ionoscloud/models/label_resources.rb +5 -3
- data/lib/ionoscloud/models/labels.rb +5 -3
- data/lib/ionoscloud/models/lan.rb +5 -3
- data/lib/ionoscloud/models/lan_entities.rb +5 -3
- data/lib/ionoscloud/models/lan_nics.rb +5 -3
- data/lib/ionoscloud/models/lan_post.rb +5 -3
- data/lib/ionoscloud/models/lan_properties.rb +5 -3
- data/lib/ionoscloud/models/lan_properties_post.rb +5 -3
- data/lib/ionoscloud/models/lans.rb +5 -3
- data/lib/ionoscloud/models/loadbalancer.rb +5 -3
- data/lib/ionoscloud/models/loadbalancer_entities.rb +5 -3
- data/lib/ionoscloud/models/loadbalancer_properties.rb +5 -3
- data/lib/ionoscloud/models/loadbalancers.rb +5 -3
- data/lib/ionoscloud/models/location.rb +5 -3
- data/lib/ionoscloud/models/location_properties.rb +5 -3
- data/lib/ionoscloud/models/locations.rb +5 -3
- data/lib/ionoscloud/models/nat_gateway.rb +5 -3
- data/lib/ionoscloud/models/nat_gateway_entities.rb +5 -3
- data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +5 -3
- data/lib/ionoscloud/models/nat_gateway_properties.rb +5 -3
- data/lib/ionoscloud/models/nat_gateway_put.rb +5 -3
- data/lib/ionoscloud/models/nat_gateway_rule.rb +5 -3
- data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +5 -3
- data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +3 -3
- data/lib/ionoscloud/models/nat_gateway_rule_put.rb +5 -3
- data/lib/ionoscloud/models/nat_gateway_rule_type.rb +3 -3
- data/lib/ionoscloud/models/nat_gateway_rules.rb +5 -3
- data/lib/ionoscloud/models/nat_gateways.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancer.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancer_entities.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +6 -14
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +7 -5
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancer_properties.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancer_put.rb +5 -3
- data/lib/ionoscloud/models/network_load_balancers.rb +5 -3
- data/lib/ionoscloud/models/nic.rb +5 -3
- data/lib/ionoscloud/models/nic_entities.rb +5 -3
- data/lib/ionoscloud/models/nic_properties.rb +5 -3
- data/lib/ionoscloud/models/nic_put.rb +5 -3
- data/lib/ionoscloud/models/nics.rb +5 -3
- data/lib/ionoscloud/models/no_state_meta_data.rb +5 -3
- data/lib/ionoscloud/models/pagination_links.rb +5 -3
- data/lib/ionoscloud/models/peer.rb +5 -3
- data/lib/ionoscloud/models/private_cross_connect.rb +5 -3
- data/lib/ionoscloud/models/private_cross_connect_properties.rb +6 -4
- data/lib/ionoscloud/models/private_cross_connects.rb +5 -3
- data/lib/ionoscloud/models/remote_console_url.rb +5 -3
- data/lib/ionoscloud/models/request.rb +5 -3
- data/lib/ionoscloud/models/request_metadata.rb +5 -3
- data/lib/ionoscloud/models/request_properties.rb +5 -3
- data/lib/ionoscloud/models/request_status.rb +5 -3
- data/lib/ionoscloud/models/request_status_metadata.rb +5 -3
- data/lib/ionoscloud/models/request_target.rb +5 -3
- data/lib/ionoscloud/models/requests.rb +6 -4
- data/lib/ionoscloud/models/resource.rb +5 -3
- data/lib/ionoscloud/models/resource_entities.rb +5 -3
- data/lib/ionoscloud/models/resource_groups.rb +5 -3
- data/lib/ionoscloud/models/resource_limits.rb +5 -3
- data/lib/ionoscloud/models/resource_properties.rb +6 -4
- data/lib/ionoscloud/models/resource_reference.rb +5 -3
- data/lib/ionoscloud/models/resources.rb +5 -3
- data/lib/ionoscloud/models/resources_users.rb +5 -3
- data/lib/ionoscloud/models/s3_bucket.rb +224 -0
- data/lib/ionoscloud/models/s3_key.rb +5 -3
- data/lib/ionoscloud/models/s3_key_metadata.rb +5 -3
- data/lib/ionoscloud/models/s3_key_properties.rb +5 -3
- data/lib/ionoscloud/models/s3_keys.rb +5 -3
- data/lib/ionoscloud/models/s3_object_storage_sso.rb +5 -3
- data/lib/ionoscloud/models/server.rb +5 -3
- data/lib/ionoscloud/models/server_entities.rb +5 -3
- data/lib/ionoscloud/models/server_properties.rb +5 -3
- data/lib/ionoscloud/models/servers.rb +5 -3
- data/lib/ionoscloud/models/snapshot.rb +5 -3
- data/lib/ionoscloud/models/snapshot_properties.rb +5 -3
- data/lib/ionoscloud/models/snapshots.rb +5 -3
- data/lib/ionoscloud/models/target_port_range.rb +5 -3
- data/lib/ionoscloud/models/template.rb +5 -3
- data/lib/ionoscloud/models/template_properties.rb +5 -3
- data/lib/ionoscloud/models/templates.rb +5 -3
- data/lib/ionoscloud/models/token.rb +5 -3
- data/lib/ionoscloud/models/type.rb +5 -5
- data/lib/ionoscloud/models/user.rb +5 -3
- data/lib/ionoscloud/models/user_metadata.rb +5 -3
- data/lib/ionoscloud/models/user_post.rb +5 -3
- data/lib/ionoscloud/models/user_properties.rb +5 -3
- data/lib/ionoscloud/models/user_properties_post.rb +5 -3
- data/lib/ionoscloud/models/user_properties_put.rb +5 -3
- data/lib/ionoscloud/models/user_put.rb +5 -3
- data/lib/ionoscloud/models/users.rb +38 -7
- data/lib/ionoscloud/models/users_entities.rb +5 -3
- data/lib/ionoscloud/models/volume.rb +5 -3
- data/lib/ionoscloud/models/volume_properties.rb +19 -8
- data/lib/ionoscloud/models/volumes.rb +5 -3
- data/lib/ionoscloud/version.rb +4 -4
- data/lib/ionoscloud.rb +4 -3
- data/spec/api/_api_spec.rb +6 -6
- data/spec/api/backup_units_api_spec.rb +23 -23
- data/spec/api/contract_resources_api_spec.rb +6 -6
- data/spec/api/data_centers_api_spec.rb +42 -42
- data/spec/api/firewall_rules_api_spec.rb +29 -29
- data/spec/api/flow_logs_api_spec.rb +23 -23
- data/spec/api/images_api_spec.rb +18 -18
- data/spec/api/ip_blocks_api_spec.rb +23 -21
- data/spec/api/kubernetes_api_spec.rb +50 -50
- data/spec/api/labels_api_spec.rb +94 -98
- data/spec/api/lans_api_spec.rb +43 -43
- data/spec/api/load_balancers_api_spec.rb +45 -49
- data/spec/api/locations_api_spec.rb +17 -17
- data/spec/api/nat_gateways_api_spec.rb +71 -73
- data/spec/api/network_interfaces_api_spec.rb +29 -29
- data/spec/api/network_load_balancers_api_spec.rb +77 -79
- data/spec/api/private_cross_connects_api_spec.rb +19 -21
- data/spec/api/requests_api_spec.rb +14 -14
- data/spec/api/servers_api_spec.rb +97 -97
- data/spec/api/snapshots_api_spec.rb +18 -18
- data/spec/api/templates_api_spec.rb +5 -5
- data/spec/api/user_management_api_spec.rb +77 -75
- data/spec/api/user_s3_keys_api_spec.rb +20 -20
- data/spec/api/volumes_api_spec.rb +37 -37
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/attached_volumes_spec.rb +3 -3
- data/spec/models/backup_unit_properties_spec.rb +3 -3
- data/spec/models/backup_unit_spec.rb +3 -3
- data/spec/models/backup_unit_sso_spec.rb +3 -3
- data/spec/models/backup_units_spec.rb +3 -3
- data/spec/models/balanced_nics_spec.rb +3 -3
- data/spec/models/cdroms_spec.rb +3 -3
- data/spec/models/connectable_datacenter_spec.rb +3 -3
- data/spec/models/contract_properties_spec.rb +3 -3
- data/spec/models/contract_spec.rb +3 -3
- data/spec/models/contracts_spec.rb +3 -3
- data/spec/models/cpu_architecture_properties_spec.rb +3 -3
- data/spec/models/data_center_entities_spec.rb +3 -3
- data/spec/models/datacenter_element_metadata_spec.rb +3 -3
- data/spec/models/datacenter_properties_spec.rb +3 -3
- data/spec/models/datacenter_spec.rb +3 -3
- data/spec/models/datacenters_spec.rb +3 -3
- data/spec/models/error_message_spec.rb +3 -3
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/firewall_rule_spec.rb +3 -3
- data/spec/models/firewall_rules_spec.rb +3 -3
- data/spec/models/firewallrule_properties_spec.rb +3 -3
- data/spec/models/flow_log_properties_spec.rb +3 -3
- data/spec/models/flow_log_put_spec.rb +3 -3
- data/spec/models/flow_log_spec.rb +3 -3
- data/spec/models/flow_logs_spec.rb +3 -3
- data/spec/models/group_entities_spec.rb +3 -3
- data/spec/models/group_members_spec.rb +3 -3
- data/spec/models/group_properties_spec.rb +3 -3
- data/spec/models/group_share_properties_spec.rb +3 -3
- data/spec/models/group_share_spec.rb +3 -3
- data/spec/models/group_shares_spec.rb +3 -3
- data/spec/models/group_spec.rb +3 -3
- data/spec/models/group_users_spec.rb +3 -3
- data/spec/models/groups_spec.rb +3 -3
- data/spec/models/image_properties_spec.rb +4 -4
- data/spec/models/image_spec.rb +3 -3
- data/spec/models/images_spec.rb +3 -3
- data/spec/models/info_spec.rb +3 -3
- data/spec/models/ip_block_properties_spec.rb +3 -3
- data/spec/models/ip_block_spec.rb +3 -3
- data/spec/models/ip_blocks_spec.rb +21 -3
- data/spec/models/ip_consumer_spec.rb +3 -3
- data/spec/models/ip_failover_spec.rb +3 -3
- data/spec/models/kubernetes_auto_scaling_spec.rb +3 -3
- data/spec/models/kubernetes_cluster_entities_spec.rb +3 -3
- data/spec/models/kubernetes_cluster_for_post_spec.rb +3 -3
- data/spec/models/kubernetes_cluster_for_put_spec.rb +3 -3
- data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +10 -4
- data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +15 -3
- data/spec/models/kubernetes_cluster_properties_spec.rb +10 -4
- data/spec/models/kubernetes_cluster_spec.rb +3 -3
- data/spec/models/kubernetes_clusters_spec.rb +3 -3
- data/spec/models/kubernetes_maintenance_window_spec.rb +3 -3
- data/spec/models/kubernetes_node_metadata_spec.rb +3 -3
- data/spec/models/kubernetes_node_pool_for_post_spec.rb +3 -3
- data/spec/models/kubernetes_node_pool_for_put_spec.rb +3 -3
- data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +3 -3
- data/spec/models/kubernetes_node_pool_lan_spec.rb +3 -3
- data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +9 -3
- data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +3 -3
- data/spec/models/kubernetes_node_pool_properties_spec.rb +9 -3
- data/spec/models/kubernetes_node_pool_spec.rb +3 -3
- data/spec/models/kubernetes_node_pools_spec.rb +3 -3
- data/spec/models/kubernetes_node_properties_spec.rb +3 -3
- data/spec/models/kubernetes_node_spec.rb +3 -3
- data/spec/models/kubernetes_nodes_spec.rb +3 -3
- data/spec/models/label_properties_spec.rb +3 -3
- data/spec/models/label_resource_properties_spec.rb +3 -3
- data/spec/models/label_resource_spec.rb +3 -3
- data/spec/models/label_resources_spec.rb +3 -3
- data/spec/models/label_spec.rb +3 -3
- data/spec/models/labels_spec.rb +3 -3
- data/spec/models/lan_entities_spec.rb +3 -3
- data/spec/models/lan_nics_spec.rb +3 -3
- data/spec/models/lan_post_spec.rb +3 -3
- data/spec/models/lan_properties_post_spec.rb +3 -3
- data/spec/models/lan_properties_spec.rb +3 -3
- data/spec/models/lan_spec.rb +3 -3
- data/spec/models/lans_spec.rb +3 -3
- data/spec/models/loadbalancer_entities_spec.rb +3 -3
- data/spec/models/loadbalancer_properties_spec.rb +3 -3
- data/spec/models/loadbalancer_spec.rb +3 -3
- data/spec/models/loadbalancers_spec.rb +3 -3
- data/spec/models/location_properties_spec.rb +3 -3
- data/spec/models/location_spec.rb +3 -3
- data/spec/models/locations_spec.rb +3 -3
- data/spec/models/nat_gateway_entities_spec.rb +3 -3
- data/spec/models/nat_gateway_lan_properties_spec.rb +3 -3
- data/spec/models/nat_gateway_properties_spec.rb +3 -3
- data/spec/models/nat_gateway_put_spec.rb +3 -3
- data/spec/models/nat_gateway_rule_properties_spec.rb +3 -3
- data/spec/models/nat_gateway_rule_protocol_spec.rb +3 -3
- data/spec/models/nat_gateway_rule_put_spec.rb +3 -3
- data/spec/models/nat_gateway_rule_spec.rb +3 -3
- data/spec/models/nat_gateway_rule_type_spec.rb +3 -3
- data/spec/models/nat_gateway_rules_spec.rb +3 -3
- data/spec/models/nat_gateway_spec.rb +3 -3
- data/spec/models/nat_gateways_spec.rb +3 -3
- data/spec/models/network_load_balancer_entities_spec.rb +3 -3
- data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +3 -9
- data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +4 -4
- data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +3 -3
- data/spec/models/network_load_balancer_forwarding_rule_spec.rb +3 -3
- data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +3 -3
- data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +3 -3
- data/spec/models/network_load_balancer_forwarding_rules_spec.rb +3 -3
- data/spec/models/network_load_balancer_properties_spec.rb +3 -3
- data/spec/models/network_load_balancer_put_spec.rb +3 -3
- data/spec/models/network_load_balancer_spec.rb +3 -3
- data/spec/models/network_load_balancers_spec.rb +3 -3
- data/spec/models/nic_entities_spec.rb +3 -3
- data/spec/models/nic_properties_spec.rb +3 -3
- data/spec/models/nic_put_spec.rb +3 -3
- data/spec/models/nic_spec.rb +3 -3
- data/spec/models/nics_spec.rb +3 -3
- data/spec/models/no_state_meta_data_spec.rb +3 -3
- data/spec/models/pagination_links_spec.rb +3 -3
- data/spec/models/peer_spec.rb +3 -3
- data/spec/models/private_cross_connect_properties_spec.rb +3 -3
- data/spec/models/private_cross_connect_spec.rb +3 -3
- data/spec/models/private_cross_connects_spec.rb +3 -3
- data/spec/models/remote_console_url_spec.rb +3 -3
- data/spec/models/request_metadata_spec.rb +3 -3
- data/spec/models/request_properties_spec.rb +3 -3
- data/spec/models/request_spec.rb +3 -3
- data/spec/models/request_status_metadata_spec.rb +3 -3
- data/spec/models/request_status_spec.rb +3 -3
- data/spec/models/request_target_spec.rb +3 -3
- data/spec/models/requests_spec.rb +3 -3
- data/spec/models/resource_entities_spec.rb +3 -3
- data/spec/models/resource_groups_spec.rb +3 -3
- data/spec/models/resource_limits_spec.rb +3 -3
- data/spec/models/resource_properties_spec.rb +3 -3
- data/spec/models/resource_reference_spec.rb +3 -3
- data/spec/models/resource_spec.rb +3 -3
- data/spec/models/resources_spec.rb +3 -3
- data/spec/models/resources_users_spec.rb +3 -3
- data/spec/models/s3_bucket_spec.rb +34 -0
- data/spec/models/s3_key_metadata_spec.rb +3 -3
- data/spec/models/s3_key_properties_spec.rb +3 -3
- data/spec/models/s3_key_spec.rb +3 -3
- data/spec/models/s3_keys_spec.rb +3 -3
- data/spec/models/s3_object_storage_sso_spec.rb +3 -3
- data/spec/models/server_entities_spec.rb +3 -3
- data/spec/models/server_properties_spec.rb +3 -3
- data/spec/models/server_spec.rb +3 -3
- data/spec/models/servers_spec.rb +3 -3
- data/spec/models/snapshot_properties_spec.rb +3 -3
- data/spec/models/snapshot_spec.rb +3 -3
- data/spec/models/snapshots_spec.rb +3 -3
- data/spec/models/target_port_range_spec.rb +3 -3
- data/spec/models/template_properties_spec.rb +3 -3
- data/spec/models/template_spec.rb +3 -3
- data/spec/models/templates_spec.rb +3 -3
- data/spec/models/token_spec.rb +3 -3
- data/spec/models/type_spec.rb +3 -3
- data/spec/models/user_metadata_spec.rb +3 -3
- data/spec/models/user_post_spec.rb +3 -3
- data/spec/models/user_properties_post_spec.rb +3 -3
- data/spec/models/user_properties_put_spec.rb +3 -3
- data/spec/models/user_properties_spec.rb +3 -3
- data/spec/models/user_put_spec.rb +3 -3
- data/spec/models/user_spec.rb +3 -3
- data/spec/models/users_entities_spec.rb +3 -3
- data/spec/models/users_spec.rb +21 -3
- data/spec/models/volume_properties_spec.rb +11 -5
- data/spec/models/volume_spec.rb +3 -3
- data/spec/models/volumes_spec.rb +3 -3
- data/spec/spec_helper.rb +3 -3
- metadata +368 -364
- data/docs/DataCentersApi.md +0 -516
- data/docs/DefaultApi.md +0 -78
- data/docs/Users.md +0 -24
@@ -0,0 +1,516 @@
|
|
1
|
+
# DataCentersApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**datacenters_delete**](DataCentersApi.md#datacenters_delete) | **DELETE** /datacenters/{datacenterId} | Delete data centers |
|
8
|
+
| [**datacenters_find_by_id**](DataCentersApi.md#datacenters_find_by_id) | **GET** /datacenters/{datacenterId} | Retrieve data centers |
|
9
|
+
| [**datacenters_get**](DataCentersApi.md#datacenters_get) | **GET** /datacenters | List your data centers |
|
10
|
+
| [**datacenters_patch**](DataCentersApi.md#datacenters_patch) | **PATCH** /datacenters/{datacenterId} | Partially modify data centers |
|
11
|
+
| [**datacenters_post**](DataCentersApi.md#datacenters_post) | **POST** /datacenters | Create data centers |
|
12
|
+
| [**datacenters_put**](DataCentersApi.md#datacenters_put) | **PUT** /datacenters/{datacenterId} | Modify data centers |
|
13
|
+
|
14
|
+
|
15
|
+
## datacenters_delete
|
16
|
+
|
17
|
+
> datacenters_delete(datacenter_id, opts)
|
18
|
+
|
19
|
+
Delete data centers
|
20
|
+
|
21
|
+
Remove the specified data center and all the elements it contains. This is method is destructive and should be used carefully.
|
22
|
+
|
23
|
+
### Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'time'
|
27
|
+
require 'ionoscloud'
|
28
|
+
# setup authorization
|
29
|
+
Ionoscloud.configure do |config|
|
30
|
+
# Configure HTTP basic authorization: Basic Authentication
|
31
|
+
config.username = 'YOUR USERNAME'
|
32
|
+
config.password = 'YOUR PASSWORD'
|
33
|
+
|
34
|
+
# Configure API key authorization: Token Authentication
|
35
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
38
|
+
end
|
39
|
+
|
40
|
+
api_instance = Ionoscloud::DataCentersApi.new
|
41
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
42
|
+
opts = {
|
43
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
44
|
+
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
|
45
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
46
|
+
}
|
47
|
+
|
48
|
+
begin
|
49
|
+
# Delete data centers
|
50
|
+
api_instance.datacenters_delete(datacenter_id, opts)
|
51
|
+
rescue Ionoscloud::ApiError => e
|
52
|
+
puts "Error when calling DataCentersApi->datacenters_delete: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
#### Using the datacenters_delete_with_http_info variant
|
57
|
+
|
58
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
59
|
+
|
60
|
+
> <Array(nil, Integer, Hash)> datacenters_delete_with_http_info(datacenter_id, opts)
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
begin
|
64
|
+
# Delete data centers
|
65
|
+
data, status_code, headers = api_instance.datacenters_delete_with_http_info(datacenter_id, opts)
|
66
|
+
p status_code # => 2xx
|
67
|
+
p headers # => { ... }
|
68
|
+
p data # => nil
|
69
|
+
rescue Ionoscloud::ApiError => e
|
70
|
+
puts "Error when calling DataCentersApi->datacenters_delete_with_http_info: #{e}"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Parameters
|
75
|
+
|
76
|
+
| Name | Type | Description | Notes |
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
78
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
79
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
80
|
+
| **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] |
|
81
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
82
|
+
|
83
|
+
### Return type
|
84
|
+
|
85
|
+
nil (empty response body)
|
86
|
+
|
87
|
+
### Authorization
|
88
|
+
|
89
|
+
Basic Authentication, Token Authentication
|
90
|
+
|
91
|
+
### HTTP request headers
|
92
|
+
|
93
|
+
- **Content-Type**: Not defined
|
94
|
+
- **Accept**: application/json
|
95
|
+
|
96
|
+
|
97
|
+
## datacenters_find_by_id
|
98
|
+
|
99
|
+
> <Datacenter> datacenters_find_by_id(datacenter_id, opts)
|
100
|
+
|
101
|
+
Retrieve data centers
|
102
|
+
|
103
|
+
Retrieve data centers by resource ID. This value is in the response body when the data center is created, and in the list of the data centers, returned by GET.
|
104
|
+
|
105
|
+
### Examples
|
106
|
+
|
107
|
+
```ruby
|
108
|
+
require 'time'
|
109
|
+
require 'ionoscloud'
|
110
|
+
# setup authorization
|
111
|
+
Ionoscloud.configure do |config|
|
112
|
+
# Configure HTTP basic authorization: Basic Authentication
|
113
|
+
config.username = 'YOUR USERNAME'
|
114
|
+
config.password = 'YOUR PASSWORD'
|
115
|
+
|
116
|
+
# Configure API key authorization: Token Authentication
|
117
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
118
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
119
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
120
|
+
end
|
121
|
+
|
122
|
+
api_instance = Ionoscloud::DataCentersApi.new
|
123
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
124
|
+
opts = {
|
125
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
126
|
+
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
|
127
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
128
|
+
}
|
129
|
+
|
130
|
+
begin
|
131
|
+
# Retrieve data centers
|
132
|
+
result = api_instance.datacenters_find_by_id(datacenter_id, opts)
|
133
|
+
p result
|
134
|
+
rescue Ionoscloud::ApiError => e
|
135
|
+
puts "Error when calling DataCentersApi->datacenters_find_by_id: #{e}"
|
136
|
+
end
|
137
|
+
```
|
138
|
+
|
139
|
+
#### Using the datacenters_find_by_id_with_http_info variant
|
140
|
+
|
141
|
+
This returns an Array which contains the response data, status code and headers.
|
142
|
+
|
143
|
+
> <Array(<Datacenter>, Integer, Hash)> datacenters_find_by_id_with_http_info(datacenter_id, opts)
|
144
|
+
|
145
|
+
```ruby
|
146
|
+
begin
|
147
|
+
# Retrieve data centers
|
148
|
+
data, status_code, headers = api_instance.datacenters_find_by_id_with_http_info(datacenter_id, opts)
|
149
|
+
p status_code # => 2xx
|
150
|
+
p headers # => { ... }
|
151
|
+
p data # => <Datacenter>
|
152
|
+
rescue Ionoscloud::ApiError => e
|
153
|
+
puts "Error when calling DataCentersApi->datacenters_find_by_id_with_http_info: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
|
159
|
+
| Name | Type | Description | Notes |
|
160
|
+
| ---- | ---- | ----------- | ----- |
|
161
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
162
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
163
|
+
| **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] |
|
164
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
165
|
+
|
166
|
+
### Return type
|
167
|
+
|
168
|
+
[**Datacenter**](Datacenter.md)
|
169
|
+
|
170
|
+
### Authorization
|
171
|
+
|
172
|
+
Basic Authentication, Token Authentication
|
173
|
+
|
174
|
+
### HTTP request headers
|
175
|
+
|
176
|
+
- **Content-Type**: Not defined
|
177
|
+
- **Accept**: application/json
|
178
|
+
|
179
|
+
|
180
|
+
## datacenters_get
|
181
|
+
|
182
|
+
> <Datacenters> datacenters_get(opts)
|
183
|
+
|
184
|
+
List your data centers
|
185
|
+
|
186
|
+
List the data centers for your account. Default limit is the first 100 items; use pagination query parameters for listing more items.
|
187
|
+
|
188
|
+
### Examples
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
require 'time'
|
192
|
+
require 'ionoscloud'
|
193
|
+
# setup authorization
|
194
|
+
Ionoscloud.configure do |config|
|
195
|
+
# Configure HTTP basic authorization: Basic Authentication
|
196
|
+
config.username = 'YOUR USERNAME'
|
197
|
+
config.password = 'YOUR PASSWORD'
|
198
|
+
|
199
|
+
# Configure API key authorization: Token Authentication
|
200
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
201
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
202
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
203
|
+
end
|
204
|
+
|
205
|
+
api_instance = Ionoscloud::DataCentersApi.new
|
206
|
+
opts = {
|
207
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
208
|
+
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
|
209
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
210
|
+
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
|
211
|
+
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
|
212
|
+
}
|
213
|
+
|
214
|
+
begin
|
215
|
+
# List your data centers
|
216
|
+
result = api_instance.datacenters_get(opts)
|
217
|
+
p result
|
218
|
+
rescue Ionoscloud::ApiError => e
|
219
|
+
puts "Error when calling DataCentersApi->datacenters_get: #{e}"
|
220
|
+
end
|
221
|
+
```
|
222
|
+
|
223
|
+
#### Using the datacenters_get_with_http_info variant
|
224
|
+
|
225
|
+
This returns an Array which contains the response data, status code and headers.
|
226
|
+
|
227
|
+
> <Array(<Datacenters>, Integer, Hash)> datacenters_get_with_http_info(opts)
|
228
|
+
|
229
|
+
```ruby
|
230
|
+
begin
|
231
|
+
# List your data centers
|
232
|
+
data, status_code, headers = api_instance.datacenters_get_with_http_info(opts)
|
233
|
+
p status_code # => 2xx
|
234
|
+
p headers # => { ... }
|
235
|
+
p data # => <Datacenters>
|
236
|
+
rescue Ionoscloud::ApiError => e
|
237
|
+
puts "Error when calling DataCentersApi->datacenters_get_with_http_info: #{e}"
|
238
|
+
end
|
239
|
+
```
|
240
|
+
|
241
|
+
### Parameters
|
242
|
+
|
243
|
+
| Name | Type | Description | Notes |
|
244
|
+
| ---- | ---- | ----------- | ----- |
|
245
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
246
|
+
| **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] |
|
247
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
248
|
+
| **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] |
|
249
|
+
| **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
|
250
|
+
|
251
|
+
### Return type
|
252
|
+
|
253
|
+
[**Datacenters**](Datacenters.md)
|
254
|
+
|
255
|
+
### Authorization
|
256
|
+
|
257
|
+
Basic Authentication, Token Authentication
|
258
|
+
|
259
|
+
### HTTP request headers
|
260
|
+
|
261
|
+
- **Content-Type**: Not defined
|
262
|
+
- **Accept**: application/json
|
263
|
+
|
264
|
+
|
265
|
+
## datacenters_patch
|
266
|
+
|
267
|
+
> <Datacenter> datacenters_patch(datacenter_id, datacenter, opts)
|
268
|
+
|
269
|
+
Partially modify data centers
|
270
|
+
|
271
|
+
Update data centers, rename them, or change their descriptions.
|
272
|
+
|
273
|
+
### Examples
|
274
|
+
|
275
|
+
```ruby
|
276
|
+
require 'time'
|
277
|
+
require 'ionoscloud'
|
278
|
+
# setup authorization
|
279
|
+
Ionoscloud.configure do |config|
|
280
|
+
# Configure HTTP basic authorization: Basic Authentication
|
281
|
+
config.username = 'YOUR USERNAME'
|
282
|
+
config.password = 'YOUR PASSWORD'
|
283
|
+
|
284
|
+
# Configure API key authorization: Token Authentication
|
285
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
286
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
287
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
288
|
+
end
|
289
|
+
|
290
|
+
api_instance = Ionoscloud::DataCentersApi.new
|
291
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
292
|
+
datacenter = Ionoscloud::DatacenterProperties.new({location: 'us/las'}) # DatacenterProperties | The modified properties of the data center.
|
293
|
+
opts = {
|
294
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
295
|
+
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
|
296
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
297
|
+
}
|
298
|
+
|
299
|
+
begin
|
300
|
+
# Partially modify data centers
|
301
|
+
result = api_instance.datacenters_patch(datacenter_id, datacenter, opts)
|
302
|
+
p result
|
303
|
+
rescue Ionoscloud::ApiError => e
|
304
|
+
puts "Error when calling DataCentersApi->datacenters_patch: #{e}"
|
305
|
+
end
|
306
|
+
```
|
307
|
+
|
308
|
+
#### Using the datacenters_patch_with_http_info variant
|
309
|
+
|
310
|
+
This returns an Array which contains the response data, status code and headers.
|
311
|
+
|
312
|
+
> <Array(<Datacenter>, Integer, Hash)> datacenters_patch_with_http_info(datacenter_id, datacenter, opts)
|
313
|
+
|
314
|
+
```ruby
|
315
|
+
begin
|
316
|
+
# Partially modify data centers
|
317
|
+
data, status_code, headers = api_instance.datacenters_patch_with_http_info(datacenter_id, datacenter, opts)
|
318
|
+
p status_code # => 2xx
|
319
|
+
p headers # => { ... }
|
320
|
+
p data # => <Datacenter>
|
321
|
+
rescue Ionoscloud::ApiError => e
|
322
|
+
puts "Error when calling DataCentersApi->datacenters_patch_with_http_info: #{e}"
|
323
|
+
end
|
324
|
+
```
|
325
|
+
|
326
|
+
### Parameters
|
327
|
+
|
328
|
+
| Name | Type | Description | Notes |
|
329
|
+
| ---- | ---- | ----------- | ----- |
|
330
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
331
|
+
| **datacenter** | [**DatacenterProperties**](DatacenterProperties.md) | The modified properties of the data center. | |
|
332
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
333
|
+
| **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] |
|
334
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
335
|
+
|
336
|
+
### Return type
|
337
|
+
|
338
|
+
[**Datacenter**](Datacenter.md)
|
339
|
+
|
340
|
+
### Authorization
|
341
|
+
|
342
|
+
Basic Authentication, Token Authentication
|
343
|
+
|
344
|
+
### HTTP request headers
|
345
|
+
|
346
|
+
- **Content-Type**: application/json
|
347
|
+
- **Accept**: application/json
|
348
|
+
|
349
|
+
|
350
|
+
## datacenters_post
|
351
|
+
|
352
|
+
> <Datacenter> datacenters_post(datacenter, opts)
|
353
|
+
|
354
|
+
Create data centers
|
355
|
+
|
356
|
+
Create new data centers, and data centers that already contain elements, such as servers and storage volumes, with this POST method. Virtual data centers are the foundation of the platform; they act as logical containers for all other objects you create, such as servers and storage volumes. You can provision as many data centers as needed. Data centers have their own private networks and are logically segmented from each other to create isolation.
|
357
|
+
|
358
|
+
### Examples
|
359
|
+
|
360
|
+
```ruby
|
361
|
+
require 'time'
|
362
|
+
require 'ionoscloud'
|
363
|
+
# setup authorization
|
364
|
+
Ionoscloud.configure do |config|
|
365
|
+
# Configure HTTP basic authorization: Basic Authentication
|
366
|
+
config.username = 'YOUR USERNAME'
|
367
|
+
config.password = 'YOUR PASSWORD'
|
368
|
+
|
369
|
+
# Configure API key authorization: Token Authentication
|
370
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
371
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
372
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
373
|
+
end
|
374
|
+
|
375
|
+
api_instance = Ionoscloud::DataCentersApi.new
|
376
|
+
datacenter = Ionoscloud::Datacenter.new({properties: Ionoscloud::DatacenterProperties.new({location: 'us/las'})}) # Datacenter | The data center to be created.
|
377
|
+
opts = {
|
378
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
379
|
+
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
|
380
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
381
|
+
}
|
382
|
+
|
383
|
+
begin
|
384
|
+
# Create data centers
|
385
|
+
result = api_instance.datacenters_post(datacenter, opts)
|
386
|
+
p result
|
387
|
+
rescue Ionoscloud::ApiError => e
|
388
|
+
puts "Error when calling DataCentersApi->datacenters_post: #{e}"
|
389
|
+
end
|
390
|
+
```
|
391
|
+
|
392
|
+
#### Using the datacenters_post_with_http_info variant
|
393
|
+
|
394
|
+
This returns an Array which contains the response data, status code and headers.
|
395
|
+
|
396
|
+
> <Array(<Datacenter>, Integer, Hash)> datacenters_post_with_http_info(datacenter, opts)
|
397
|
+
|
398
|
+
```ruby
|
399
|
+
begin
|
400
|
+
# Create data centers
|
401
|
+
data, status_code, headers = api_instance.datacenters_post_with_http_info(datacenter, opts)
|
402
|
+
p status_code # => 2xx
|
403
|
+
p headers # => { ... }
|
404
|
+
p data # => <Datacenter>
|
405
|
+
rescue Ionoscloud::ApiError => e
|
406
|
+
puts "Error when calling DataCentersApi->datacenters_post_with_http_info: #{e}"
|
407
|
+
end
|
408
|
+
```
|
409
|
+
|
410
|
+
### Parameters
|
411
|
+
|
412
|
+
| Name | Type | Description | Notes |
|
413
|
+
| ---- | ---- | ----------- | ----- |
|
414
|
+
| **datacenter** | [**Datacenter**](Datacenter.md) | The data center to be created. | |
|
415
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
416
|
+
| **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] |
|
417
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
418
|
+
|
419
|
+
### Return type
|
420
|
+
|
421
|
+
[**Datacenter**](Datacenter.md)
|
422
|
+
|
423
|
+
### Authorization
|
424
|
+
|
425
|
+
Basic Authentication, Token Authentication
|
426
|
+
|
427
|
+
### HTTP request headers
|
428
|
+
|
429
|
+
- **Content-Type**: application/json
|
430
|
+
- **Accept**: application/json
|
431
|
+
|
432
|
+
|
433
|
+
## datacenters_put
|
434
|
+
|
435
|
+
> <Datacenter> datacenters_put(datacenter_id, datacenter, opts)
|
436
|
+
|
437
|
+
Modify data centers
|
438
|
+
|
439
|
+
Update data centers, rename them, or change their descriptions.
|
440
|
+
|
441
|
+
### Examples
|
442
|
+
|
443
|
+
```ruby
|
444
|
+
require 'time'
|
445
|
+
require 'ionoscloud'
|
446
|
+
# setup authorization
|
447
|
+
Ionoscloud.configure do |config|
|
448
|
+
# Configure HTTP basic authorization: Basic Authentication
|
449
|
+
config.username = 'YOUR USERNAME'
|
450
|
+
config.password = 'YOUR PASSWORD'
|
451
|
+
|
452
|
+
# Configure API key authorization: Token Authentication
|
453
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
454
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
455
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
456
|
+
end
|
457
|
+
|
458
|
+
api_instance = Ionoscloud::DataCentersApi.new
|
459
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
460
|
+
datacenter = Ionoscloud::Datacenter.new({properties: Ionoscloud::DatacenterProperties.new({location: 'us/las'})}) # Datacenter | The modified data center.
|
461
|
+
opts = {
|
462
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
463
|
+
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
|
464
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
465
|
+
}
|
466
|
+
|
467
|
+
begin
|
468
|
+
# Modify data centers
|
469
|
+
result = api_instance.datacenters_put(datacenter_id, datacenter, opts)
|
470
|
+
p result
|
471
|
+
rescue Ionoscloud::ApiError => e
|
472
|
+
puts "Error when calling DataCentersApi->datacenters_put: #{e}"
|
473
|
+
end
|
474
|
+
```
|
475
|
+
|
476
|
+
#### Using the datacenters_put_with_http_info variant
|
477
|
+
|
478
|
+
This returns an Array which contains the response data, status code and headers.
|
479
|
+
|
480
|
+
> <Array(<Datacenter>, Integer, Hash)> datacenters_put_with_http_info(datacenter_id, datacenter, opts)
|
481
|
+
|
482
|
+
```ruby
|
483
|
+
begin
|
484
|
+
# Modify data centers
|
485
|
+
data, status_code, headers = api_instance.datacenters_put_with_http_info(datacenter_id, datacenter, opts)
|
486
|
+
p status_code # => 2xx
|
487
|
+
p headers # => { ... }
|
488
|
+
p data # => <Datacenter>
|
489
|
+
rescue Ionoscloud::ApiError => e
|
490
|
+
puts "Error when calling DataCentersApi->datacenters_put_with_http_info: #{e}"
|
491
|
+
end
|
492
|
+
```
|
493
|
+
|
494
|
+
### Parameters
|
495
|
+
|
496
|
+
| Name | Type | Description | Notes |
|
497
|
+
| ---- | ---- | ----------- | ----- |
|
498
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
499
|
+
| **datacenter** | [**Datacenter**](Datacenter.md) | The modified data center. | |
|
500
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
501
|
+
| **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] |
|
502
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
503
|
+
|
504
|
+
### Return type
|
505
|
+
|
506
|
+
[**Datacenter**](Datacenter.md)
|
507
|
+
|
508
|
+
### Authorization
|
509
|
+
|
510
|
+
Basic Authentication, Token Authentication
|
511
|
+
|
512
|
+
### HTTP request headers
|
513
|
+
|
514
|
+
- **Content-Type**: application/json
|
515
|
+
- **Accept**: application/json
|
516
|
+
|
@@ -0,0 +1,78 @@
|
|
1
|
+
# DefaultApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**api_info_get**](DefaultApi.md#api_info_get) | **GET** / | Display API information |
|
8
|
+
|
9
|
+
|
10
|
+
## api_info_get
|
11
|
+
|
12
|
+
> <Info> api_info_get(opts)
|
13
|
+
|
14
|
+
Display API information
|
15
|
+
|
16
|
+
Display API information
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'ionoscloud'
|
23
|
+
|
24
|
+
api_instance = Ionoscloud::DefaultApi.new
|
25
|
+
opts = {
|
26
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
27
|
+
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
|
28
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
29
|
+
}
|
30
|
+
|
31
|
+
begin
|
32
|
+
# Display API information
|
33
|
+
result = api_instance.api_info_get(opts)
|
34
|
+
p result
|
35
|
+
rescue Ionoscloud::ApiError => e
|
36
|
+
puts "Error when calling DefaultApi->api_info_get: #{e}"
|
37
|
+
end
|
38
|
+
```
|
39
|
+
|
40
|
+
#### Using the api_info_get_with_http_info variant
|
41
|
+
|
42
|
+
This returns an Array which contains the response data, status code and headers.
|
43
|
+
|
44
|
+
> <Array(<Info>, Integer, Hash)> api_info_get_with_http_info(opts)
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
begin
|
48
|
+
# Display API information
|
49
|
+
data, status_code, headers = api_instance.api_info_get_with_http_info(opts)
|
50
|
+
p status_code # => 2xx
|
51
|
+
p headers # => { ... }
|
52
|
+
p data # => <Info>
|
53
|
+
rescue Ionoscloud::ApiError => e
|
54
|
+
puts "Error when calling DefaultApi->api_info_get_with_http_info: #{e}"
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
### Parameters
|
59
|
+
|
60
|
+
| Name | Type | Description | Notes |
|
61
|
+
| ---- | ---- | ----------- | ----- |
|
62
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
63
|
+
| **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] |
|
64
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
65
|
+
|
66
|
+
### Return type
|
67
|
+
|
68
|
+
[**Info**](Info.md)
|
69
|
+
|
70
|
+
### Authorization
|
71
|
+
|
72
|
+
No authorization required
|
73
|
+
|
74
|
+
### HTTP request headers
|
75
|
+
|
76
|
+
- **Content-Type**: Not defined
|
77
|
+
- **Accept**: application/json
|
78
|
+
|