ionoscloud 5.0.0 → 6.0.0.beta.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/docs/AttachedVolumes.md +30 -0
- data/docs/BackupUnit.md +26 -0
- data/docs/BackupUnitProperties.md +22 -0
- data/docs/BackupUnitSSO.md +18 -0
- data/docs/BackupUnits.md +24 -0
- data/docs/BackupUnitsApi.md +594 -0
- data/docs/BalancedNics.md +30 -0
- data/docs/CHANGELOG.md +1 -0
- data/docs/Cdroms.md +30 -0
- data/docs/ConnectableDatacenter.md +22 -0
- data/docs/Contract.md +20 -0
- data/docs/ContractProperties.md +26 -0
- data/docs/ContractResourcesApi.md +89 -0
- data/docs/Contracts.md +24 -0
- data/docs/CpuArchitectureProperties.md +24 -0
- data/docs/DataCenterEntities.md +28 -0
- data/docs/DataCentersApi.md +516 -0
- data/docs/Datacenter.md +28 -0
- data/docs/DatacenterElementMetadata.md +32 -0
- data/docs/DatacenterProperties.md +30 -0
- data/docs/Datacenters.md +30 -0
- data/docs/DefaultApi.md +78 -0
- data/docs/Error.md +20 -0
- data/docs/ErrorMessage.md +20 -0
- data/docs/FirewallRule.md +26 -0
- data/docs/FirewallRules.md +30 -0
- data/docs/FirewallRulesApi.md +552 -0
- data/docs/FirewallruleProperties.md +36 -0
- data/docs/FlowLog.md +26 -0
- data/docs/FlowLogProperties.md +24 -0
- data/docs/FlowLogPut.md +24 -0
- data/docs/FlowLogs.md +30 -0
- data/docs/FlowLogsApi.md +540 -0
- data/docs/Group.md +26 -0
- data/docs/GroupEntities.md +20 -0
- data/docs/GroupMembers.md +24 -0
- data/docs/GroupProperties.md +42 -0
- data/docs/GroupShare.md +24 -0
- data/docs/GroupShareProperties.md +20 -0
- data/docs/GroupShares.md +24 -0
- data/docs/GroupUsers.md +24 -0
- data/docs/Groups.md +24 -0
- data/docs/IPBlocksApi.md +512 -0
- data/docs/IPFailover.md +20 -0
- data/docs/Image.md +26 -0
- data/docs/ImageProperties.md +54 -0
- data/docs/Images.md +24 -0
- data/docs/ImagesApi.md +428 -0
- data/docs/Info.md +22 -0
- data/docs/IpBlock.md +26 -0
- data/docs/IpBlockProperties.md +26 -0
- data/docs/IpBlocks.md +24 -0
- data/docs/IpConsumer.md +34 -0
- data/docs/KubernetesApi.md +1433 -0
- data/docs/KubernetesAutoScaling.md +20 -0
- data/docs/KubernetesCluster.md +28 -0
- data/docs/KubernetesClusterEntities.md +18 -0
- data/docs/KubernetesClusterForPost.md +28 -0
- data/docs/KubernetesClusterForPut.md +28 -0
- data/docs/KubernetesClusterProperties.md +30 -0
- data/docs/KubernetesClusterPropertiesForPost.md +26 -0
- data/docs/KubernetesClusterPropertiesForPut.md +22 -0
- data/docs/KubernetesClusters.md +24 -0
- data/docs/KubernetesMaintenanceWindow.md +20 -0
- data/docs/KubernetesNode.md +26 -0
- data/docs/KubernetesNodeMetadata.md +26 -0
- data/docs/KubernetesNodePool.md +26 -0
- data/docs/KubernetesNodePoolForPost.md +26 -0
- data/docs/KubernetesNodePoolForPut.md +26 -0
- data/docs/KubernetesNodePoolLan.md +22 -0
- data/docs/KubernetesNodePoolLanRoutes.md +20 -0
- data/docs/KubernetesNodePoolProperties.md +50 -0
- data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
- data/docs/KubernetesNodePoolPropertiesForPut.md +34 -0
- data/docs/KubernetesNodePools.md +24 -0
- data/docs/KubernetesNodeProperties.md +24 -0
- data/docs/KubernetesNodes.md +24 -0
- data/docs/Label.md +26 -0
- data/docs/LabelProperties.md +26 -0
- data/docs/LabelResource.md +26 -0
- data/docs/LabelResourceProperties.md +20 -0
- data/docs/LabelResources.md +30 -0
- data/docs/Labels.md +24 -0
- data/docs/LabelsApi.md +2346 -0
- data/docs/Lan.md +28 -0
- data/docs/LanEntities.md +18 -0
- data/docs/LanNics.md +30 -0
- data/docs/LanPost.md +28 -0
- data/docs/LanProperties.md +24 -0
- data/docs/LanPropertiesPost.md +24 -0
- data/docs/Lans.md +30 -0
- data/docs/LansApi.md +794 -0
- data/docs/LoadBalancersApi.md +885 -0
- data/docs/Loadbalancer.md +28 -0
- data/docs/LoadbalancerEntities.md +18 -0
- data/docs/LoadbalancerProperties.md +22 -0
- data/docs/Loadbalancers.md +30 -0
- data/docs/Location.md +26 -0
- data/docs/LocationProperties.md +24 -0
- data/docs/Locations.md +24 -0
- data/docs/LocationsApi.md +259 -0
- data/docs/NATGatewaysApi.md +1578 -0
- data/docs/NatGateway.md +28 -0
- data/docs/NatGatewayEntities.md +20 -0
- data/docs/NatGatewayLanProperties.md +20 -0
- data/docs/NatGatewayProperties.md +22 -0
- data/docs/NatGatewayPut.md +24 -0
- data/docs/NatGatewayRule.md +26 -0
- data/docs/NatGatewayRuleProperties.md +30 -0
- data/docs/NatGatewayRuleProtocol.md +15 -0
- data/docs/NatGatewayRulePut.md +24 -0
- data/docs/NatGatewayRuleType.md +15 -0
- data/docs/NatGatewayRules.md +24 -0
- data/docs/NatGateways.md +30 -0
- data/docs/NetworkInterfacesApi.md +540 -0
- data/docs/NetworkLoadBalancer.md +28 -0
- data/docs/NetworkLoadBalancerEntities.md +20 -0
- data/docs/NetworkLoadBalancerForwardingRule.md +26 -0
- data/docs/NetworkLoadBalancerForwardingRuleHealthCheck.md +26 -0
- data/docs/NetworkLoadBalancerForwardingRuleProperties.md +30 -0
- data/docs/NetworkLoadBalancerForwardingRulePut.md +24 -0
- data/docs/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
- data/docs/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
- data/docs/NetworkLoadBalancerForwardingRules.md +30 -0
- data/docs/NetworkLoadBalancerProperties.md +26 -0
- data/docs/NetworkLoadBalancerPut.md +24 -0
- data/docs/NetworkLoadBalancers.md +30 -0
- data/docs/NetworkLoadBalancersApi.md +1590 -0
- data/docs/Nic.md +28 -0
- data/docs/NicEntities.md +20 -0
- data/docs/NicProperties.md +34 -0
- data/docs/NicPut.md +24 -0
- data/docs/Nics.md +30 -0
- data/docs/NoStateMetaData.md +30 -0
- data/docs/PaginationLinks.md +22 -0
- data/docs/Peer.md +26 -0
- data/docs/PrivateCrossConnect.md +26 -0
- data/docs/PrivateCrossConnectProperties.md +24 -0
- data/docs/PrivateCrossConnects.md +24 -0
- data/docs/PrivateCrossConnectsApi.md +430 -0
- data/docs/README.md +111 -0
- data/docs/RemoteConsoleUrl.md +18 -0
- data/docs/Request.md +26 -0
- data/docs/RequestMetadata.md +24 -0
- data/docs/RequestProperties.md +24 -0
- data/docs/RequestStatus.md +24 -0
- data/docs/RequestStatusMetadata.md +24 -0
- data/docs/RequestTarget.md +20 -0
- data/docs/Requests.md +30 -0
- data/docs/RequestsApi.md +283 -0
- data/docs/Resource.md +28 -0
- data/docs/ResourceEntities.md +18 -0
- data/docs/ResourceGroups.md +24 -0
- data/docs/ResourceLimits.md +60 -0
- data/docs/ResourceProperties.md +20 -0
- data/docs/ResourceReference.md +22 -0
- data/docs/Resources.md +24 -0
- data/docs/ResourcesUsers.md +24 -0
- data/docs/S3Key.md +26 -0
- data/docs/S3KeyMetadata.md +20 -0
- data/docs/S3KeyProperties.md +20 -0
- data/docs/S3Keys.md +24 -0
- data/docs/S3ObjectStorageSSO.md +18 -0
- data/docs/Server.md +28 -0
- data/docs/ServerEntities.md +22 -0
- data/docs/ServerProperties.md +36 -0
- data/docs/Servers.md +30 -0
- data/docs/ServersApi.md +1908 -0
- data/docs/Snapshot.md +26 -0
- data/docs/SnapshotProperties.md +48 -0
- data/docs/Snapshots.md +24 -0
- data/docs/SnapshotsApi.md +428 -0
- data/docs/TargetPortRange.md +20 -0
- data/docs/Template.md +26 -0
- data/docs/TemplateProperties.md +24 -0
- data/docs/Templates.md +24 -0
- data/docs/TemplatesApi.md +165 -0
- data/docs/Token.md +18 -0
- data/docs/Type.md +15 -0
- data/docs/User.md +28 -0
- data/docs/UserManagementApi.md +2033 -0
- data/docs/UserMetadata.md +22 -0
- data/docs/UserPost.md +18 -0
- data/docs/UserProperties.md +32 -0
- data/docs/UserPropertiesPost.md +32 -0
- data/docs/UserPropertiesPut.md +30 -0
- data/docs/UserPut.md +20 -0
- data/docs/UserS3KeysApi.md +516 -0
- data/docs/Users.md +24 -0
- data/docs/UsersEntities.md +20 -0
- data/docs/Volume.md +26 -0
- data/docs/VolumeProperties.md +54 -0
- data/docs/Volumes.md +30 -0
- data/docs/VolumesApi.md +709 -0
- data/docs/summary.md +395 -0
- data/gitbook.yaml +4 -0
- data/ionoscloud.gemspec +1 -1
- data/lib/ionoscloud.rb +68 -18
- data/lib/ionoscloud/api/_api.rb +1 -1
- data/lib/ionoscloud/api/{backup_unit_api.rb → backup_units_api.rb} +60 -60
- data/lib/ionoscloud/api/{contract_api.rb → contract_resources_api.rb} +12 -12
- data/lib/ionoscloud/api/{data_center_api.rb → data_centers_api.rb} +51 -51
- data/lib/ionoscloud/api/firewall_rules_api.rb +640 -0
- data/lib/ionoscloud/api/flow_logs_api.rb +622 -0
- data/lib/ionoscloud/api/{image_api.rb → images_api.rb} +40 -40
- data/lib/ionoscloud/api/ip_blocks_api.rb +16 -16
- data/lib/ionoscloud/api/kubernetes_api.rb +33 -96
- data/lib/ionoscloud/api/{label_api.rb → labels_api.rb} +269 -287
- data/lib/ionoscloud/api/{lan_api.rb → lans_api.rb} +105 -105
- data/lib/ionoscloud/api/{load_balancer_api.rb → load_balancers_api.rb} +153 -135
- data/lib/ionoscloud/api/{location_api.rb → locations_api.rb} +20 -20
- data/lib/ionoscloud/api/nat_gateways_api.rb +1690 -0
- data/lib/ionoscloud/api/network_interfaces_api.rb +604 -0
- data/lib/ionoscloud/api/network_load_balancers_api.rb +1708 -0
- data/lib/ionoscloud/api/{private_cross_connect_api.rb → private_cross_connects_api.rb} +61 -43
- data/lib/ionoscloud/api/{request_api.rb → requests_api.rb} +56 -32
- data/lib/ionoscloud/api/{server_api.rb → servers_api.rb} +535 -191
- data/lib/ionoscloud/api/{snapshot_api.rb → snapshots_api.rb} +46 -46
- data/lib/ionoscloud/api/templates_api.rb +164 -0
- data/lib/ionoscloud/api/user_management_api.rb +29 -524
- data/lib/ionoscloud/api/user_s3_keys_api.rb +517 -0
- data/lib/ionoscloud/api/{volume_api.rb → volumes_api.rb} +80 -80
- data/lib/ionoscloud/api_client.rb +19 -23
- data/lib/ionoscloud/api_error.rb +1 -1
- data/lib/ionoscloud/configuration.rb +5 -5
- data/lib/ionoscloud/models/attached_volumes.rb +1 -1
- data/lib/ionoscloud/models/backup_unit.rb +1 -1
- data/lib/ionoscloud/models/backup_unit_properties.rb +1 -1
- data/lib/ionoscloud/models/backup_unit_sso.rb +1 -1
- data/lib/ionoscloud/models/backup_units.rb +3 -3
- data/lib/ionoscloud/models/balanced_nics.rb +1 -1
- data/lib/ionoscloud/models/cdroms.rb +1 -1
- data/lib/ionoscloud/models/connectable_datacenter.rb +1 -1
- data/lib/ionoscloud/models/contract.rb +1 -1
- data/lib/ionoscloud/models/contract_properties.rb +1 -1
- data/lib/ionoscloud/models/contracts.rb +249 -0
- data/lib/ionoscloud/models/cpu_architecture_properties.rb +247 -0
- data/lib/ionoscloud/models/data_center_entities.rb +23 -5
- data/lib/ionoscloud/models/datacenter.rb +1 -1
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +1 -1
- data/lib/ionoscloud/models/datacenter_properties.rb +16 -26
- data/lib/ionoscloud/models/datacenters.rb +1 -1
- data/lib/ionoscloud/models/error.rb +1 -1
- data/lib/ionoscloud/models/error_message.rb +1 -1
- data/lib/ionoscloud/models/firewall_rule.rb +1 -1
- data/lib/ionoscloud/models/firewall_rules.rb +1 -1
- data/lib/ionoscloud/models/firewallrule_properties.rb +63 -26
- data/lib/ionoscloud/models/flow_log.rb +260 -0
- data/lib/ionoscloud/models/flow_log_properties.rb +313 -0
- data/lib/ionoscloud/models/flow_log_put.rb +251 -0
- data/lib/ionoscloud/models/flow_logs.rb +278 -0
- data/lib/ionoscloud/models/group.rb +1 -1
- data/lib/ionoscloud/models/group_entities.rb +1 -1
- data/lib/ionoscloud/models/group_members.rb +1 -1
- data/lib/ionoscloud/models/group_properties.rb +35 -5
- data/lib/ionoscloud/models/group_share.rb +1 -1
- data/lib/ionoscloud/models/group_share_properties.rb +1 -1
- data/lib/ionoscloud/models/group_shares.rb +1 -1
- data/lib/ionoscloud/models/group_users.rb +1 -1
- data/lib/ionoscloud/models/groups.rb +1 -1
- data/lib/ionoscloud/models/image.rb +1 -1
- data/lib/ionoscloud/models/image_properties.rb +39 -5
- data/lib/ionoscloud/models/images.rb +1 -1
- data/lib/ionoscloud/models/info.rb +1 -1
- data/lib/ionoscloud/models/ip_block.rb +1 -1
- data/lib/ionoscloud/models/ip_block_properties.rb +1 -1
- data/lib/ionoscloud/models/ip_blocks.rb +1 -1
- data/lib/ionoscloud/models/ip_consumer.rb +23 -5
- data/lib/ionoscloud/models/ip_failover.rb +1 -1
- data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +11 -1
- data/lib/ionoscloud/models/kubernetes_cluster.rb +1 -1
- data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +1 -1
- data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +303 -0
- data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +303 -0
- data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +27 -5
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +263 -0
- data/lib/ionoscloud/models/{kubernetes_cluster_properties_for_post_and_put.rb → kubernetes_cluster_properties_for_put.rb} +5 -5
- data/lib/ionoscloud/models/kubernetes_clusters.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +11 -1
- data/lib/ionoscloud/models/kubernetes_node.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +1 -1
- data/lib/ionoscloud/models/kubernetes_node_pool.rb +1 -1
- data/lib/ionoscloud/models/{kubernetes_config.rb → kubernetes_node_pool_for_post.rb} +17 -8
- data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +1 -1
- data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +27 -5
- data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +227 -0
- data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +2 -153
- data/lib/ionoscloud/models/kubernetes_node_pools.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_properties.rb +12 -7
- data/lib/ionoscloud/models/kubernetes_nodes.rb +3 -3
- data/lib/ionoscloud/models/label.rb +1 -1
- data/lib/ionoscloud/models/label_properties.rb +1 -1
- data/lib/ionoscloud/models/label_resource.rb +1 -1
- data/lib/ionoscloud/models/label_resource_properties.rb +1 -1
- data/lib/ionoscloud/models/label_resources.rb +3 -3
- data/lib/ionoscloud/models/labels.rb +3 -3
- data/lib/ionoscloud/models/lan.rb +1 -1
- data/lib/ionoscloud/models/lan_entities.rb +1 -1
- data/lib/ionoscloud/models/lan_nics.rb +1 -1
- data/lib/ionoscloud/models/lan_post.rb +1 -1
- data/lib/ionoscloud/models/lan_properties.rb +1 -1
- data/lib/ionoscloud/models/lan_properties_post.rb +1 -1
- data/lib/ionoscloud/models/lans.rb +2 -2
- data/lib/ionoscloud/models/loadbalancer.rb +1 -1
- data/lib/ionoscloud/models/loadbalancer_entities.rb +1 -1
- data/lib/ionoscloud/models/loadbalancer_properties.rb +13 -30
- data/lib/ionoscloud/models/loadbalancers.rb +1 -1
- data/lib/ionoscloud/models/location.rb +1 -1
- data/lib/ionoscloud/models/location_properties.rb +16 -26
- data/lib/ionoscloud/models/locations.rb +1 -1
- data/lib/ionoscloud/models/nat_gateway.rb +269 -0
- data/lib/ionoscloud/models/nat_gateway_entities.rb +225 -0
- data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +234 -0
- data/lib/ionoscloud/models/nat_gateway_properties.rb +251 -0
- data/lib/ionoscloud/models/nat_gateway_put.rb +251 -0
- data/lib/ionoscloud/models/nat_gateway_rule.rb +260 -0
- data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +291 -0
- data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +39 -0
- data/lib/ionoscloud/models/nat_gateway_rule_put.rb +251 -0
- data/lib/ionoscloud/models/nat_gateway_rule_type.rb +36 -0
- data/lib/ionoscloud/models/nat_gateway_rules.rb +249 -0
- data/lib/ionoscloud/models/nat_gateways.rb +278 -0
- data/lib/ionoscloud/models/network_load_balancer.rb +269 -0
- data/lib/ionoscloud/models/network_load_balancer_entities.rb +225 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +260 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +257 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +354 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +251 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +261 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +237 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +278 -0
- data/lib/ionoscloud/models/network_load_balancer_properties.rb +276 -0
- data/lib/ionoscloud/models/network_load_balancer_put.rb +251 -0
- data/lib/ionoscloud/models/network_load_balancers.rb +278 -0
- data/lib/ionoscloud/models/nic.rb +1 -1
- data/lib/ionoscloud/models/nic_entities.rb +11 -2
- data/lib/ionoscloud/models/nic_properties.rb +63 -9
- data/lib/ionoscloud/models/nic_put.rb +251 -0
- data/lib/ionoscloud/models/nics.rb +1 -1
- data/lib/ionoscloud/models/no_state_meta_data.rb +1 -1
- data/lib/ionoscloud/models/pagination_links.rb +1 -1
- data/lib/ionoscloud/models/peer.rb +1 -1
- data/lib/ionoscloud/models/private_cross_connect.rb +1 -1
- data/lib/ionoscloud/models/private_cross_connect_properties.rb +1 -1
- data/lib/ionoscloud/models/private_cross_connects.rb +1 -1
- data/lib/ionoscloud/models/{kubernetes_config_properties.rb → remote_console_url.rb} +12 -12
- data/lib/ionoscloud/models/request.rb +1 -1
- data/lib/ionoscloud/models/request_metadata.rb +1 -1
- data/lib/ionoscloud/models/request_properties.rb +1 -1
- data/lib/ionoscloud/models/request_status.rb +1 -1
- data/lib/ionoscloud/models/request_status_metadata.rb +1 -1
- data/lib/ionoscloud/models/request_target.rb +1 -1
- data/lib/ionoscloud/models/requests.rb +1 -1
- data/lib/ionoscloud/models/resource.rb +1 -1
- data/lib/ionoscloud/models/resource_entities.rb +1 -1
- data/lib/ionoscloud/models/resource_groups.rb +1 -1
- data/lib/ionoscloud/models/resource_limits.rb +80 -5
- data/lib/ionoscloud/models/resource_properties.rb +1 -1
- data/lib/ionoscloud/models/resource_reference.rb +1 -1
- data/lib/ionoscloud/models/resources.rb +1 -1
- data/lib/ionoscloud/models/resources_users.rb +1 -1
- data/lib/ionoscloud/models/s3_key.rb +1 -1
- data/lib/ionoscloud/models/s3_key_metadata.rb +1 -1
- data/lib/ionoscloud/models/s3_key_properties.rb +3 -3
- data/lib/ionoscloud/models/s3_keys.rb +1 -1
- data/lib/ionoscloud/models/s3_object_storage_sso.rb +1 -1
- data/lib/ionoscloud/models/server.rb +1 -1
- data/lib/ionoscloud/models/server_entities.rb +1 -1
- data/lib/ionoscloud/models/server_properties.rb +28 -8
- data/lib/ionoscloud/models/servers.rb +1 -1
- data/lib/ionoscloud/models/snapshot.rb +1 -1
- data/lib/ionoscloud/models/snapshot_properties.rb +1 -1
- data/lib/ionoscloud/models/snapshots.rb +1 -1
- data/lib/ionoscloud/models/target_port_range.rb +227 -0
- data/lib/ionoscloud/models/template.rb +260 -0
- data/lib/ionoscloud/models/template_properties.rb +267 -0
- data/lib/ionoscloud/models/templates.rb +249 -0
- data/lib/ionoscloud/models/token.rb +217 -0
- data/lib/ionoscloud/models/type.rb +10 -1
- data/lib/ionoscloud/models/user.rb +1 -1
- data/lib/ionoscloud/models/user_metadata.rb +1 -1
- data/lib/ionoscloud/models/user_post.rb +221 -0
- data/lib/ionoscloud/models/user_properties.rb +2 -12
- data/lib/ionoscloud/models/user_properties_post.rb +287 -0
- data/lib/ionoscloud/models/user_properties_put.rb +277 -0
- data/lib/ionoscloud/models/user_put.rb +231 -0
- data/lib/ionoscloud/models/users.rb +1 -1
- data/lib/ionoscloud/models/users_entities.rb +1 -1
- data/lib/ionoscloud/models/volume.rb +1 -1
- data/lib/ionoscloud/models/volume_properties.rb +31 -20
- data/lib/ionoscloud/models/volumes.rb +1 -1
- data/lib/ionoscloud/version.rb +2 -2
- data/spec/api/_api_spec.rb +1 -1
- data/spec/api/{backup_unit_api_spec.rb → backup_units_api_spec.rb} +14 -14
- data/spec/api/{contract_api_spec.rb → contract_resources_api_spec.rb} +9 -9
- data/spec/api/{data_center_api_spec.rb → data_centers_api_spec.rb} +10 -10
- data/spec/api/firewall_rules_api_spec.rb +146 -0
- data/spec/api/flow_logs_api_spec.rb +140 -0
- data/spec/api/{image_api_spec.rb → images_api_spec.rb} +9 -9
- data/spec/api/ip_blocks_api_spec.rb +7 -7
- data/spec/api/kubernetes_api_spec.rb +10 -22
- data/spec/api/{label_api_spec.rb → labels_api_spec.rb} +21 -23
- data/spec/api/{lan_api_spec.rb → lans_api_spec.rb} +21 -21
- data/spec/api/{load_balancer_api_spec.rb → load_balancers_api_spec.rb} +27 -25
- data/spec/api/{location_api_spec.rb → locations_api_spec.rb} +7 -7
- data/spec/api/{nic_api_spec.rb → nat_gateways_api_spec.rb} +188 -103
- data/spec/api/network_interfaces_api_spec.rb +140 -0
- data/spec/api/network_load_balancers_api_spec.rb +342 -0
- data/spec/api/{private_cross_connect_api_spec.rb → private_cross_connects_api_spec.rb} +13 -11
- data/spec/api/{request_api_spec.rb → requests_api_spec.rb} +20 -12
- data/spec/api/{server_api_spec.rb → servers_api_spec.rb} +84 -20
- data/spec/api/{snapshot_api_spec.rb → snapshots_api_spec.rb} +12 -12
- data/spec/api/templates_api_spec.rb +60 -0
- data/spec/api/user_management_api_spec.rb +7 -100
- data/spec/api/user_s3_keys_api_spec.rb +128 -0
- data/spec/api/{volume_api_spec.rb → volumes_api_spec.rb} +13 -13
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +4 -4
- data/spec/models/attached_volumes_spec.rb +1 -1
- data/spec/models/backup_unit_properties_spec.rb +1 -1
- data/spec/models/backup_unit_spec.rb +1 -1
- data/spec/models/backup_unit_sso_spec.rb +1 -1
- data/spec/models/backup_units_spec.rb +2 -2
- data/spec/models/balanced_nics_spec.rb +1 -1
- data/spec/models/cdroms_spec.rb +1 -1
- data/spec/models/connectable_datacenter_spec.rb +1 -1
- data/spec/models/contract_properties_spec.rb +1 -1
- data/spec/models/contract_spec.rb +1 -1
- data/spec/models/contracts_spec.rb +52 -0
- data/spec/models/cpu_architecture_properties_spec.rb +52 -0
- data/spec/models/data_center_entities_spec.rb +13 -1
- data/spec/models/datacenter_element_metadata_spec.rb +1 -1
- data/spec/models/datacenter_properties_spec.rb +7 -5
- data/spec/models/datacenter_spec.rb +1 -1
- data/spec/models/datacenters_spec.rb +1 -1
- data/spec/models/error_message_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/firewall_rule_spec.rb +1 -1
- data/spec/models/firewall_rules_spec.rb +1 -1
- data/spec/models/firewallrule_properties_spec.rb +11 -13
- data/spec/models/flow_log_properties_spec.rb +60 -0
- data/spec/models/flow_log_put_spec.rb +52 -0
- data/spec/models/flow_log_spec.rb +58 -0
- data/spec/models/flow_logs_spec.rb +70 -0
- data/spec/models/group_entities_spec.rb +1 -1
- data/spec/models/group_members_spec.rb +1 -1
- data/spec/models/group_properties_spec.rb +19 -1
- data/spec/models/group_share_properties_spec.rb +1 -1
- data/spec/models/group_share_spec.rb +1 -1
- data/spec/models/group_shares_spec.rb +1 -1
- data/spec/models/group_spec.rb +1 -1
- data/spec/models/group_users_spec.rb +1 -1
- data/spec/models/groups_spec.rb +1 -1
- data/spec/models/image_properties_spec.rb +17 -1
- data/spec/models/image_spec.rb +1 -1
- data/spec/models/images_spec.rb +1 -1
- data/spec/models/info_spec.rb +1 -1
- data/spec/models/ip_block_properties_spec.rb +1 -1
- data/spec/models/ip_block_spec.rb +1 -1
- data/spec/models/ip_blocks_spec.rb +1 -1
- data/spec/models/ip_consumer_spec.rb +13 -1
- data/spec/models/ip_failover_spec.rb +1 -1
- data/spec/models/kubernetes_auto_scaling_spec.rb +1 -1
- data/spec/models/kubernetes_cluster_entities_spec.rb +1 -1
- data/spec/models/kubernetes_cluster_for_post_spec.rb +68 -0
- data/spec/models/kubernetes_cluster_for_put_spec.rb +68 -0
- data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +58 -0
- data/spec/models/{kubernetes_cluster_properties_for_post_and_put_spec.rb → kubernetes_cluster_properties_for_put_spec.rb} +7 -7
- data/spec/models/kubernetes_cluster_properties_spec.rb +13 -1
- data/spec/models/kubernetes_cluster_spec.rb +1 -1
- data/spec/models/kubernetes_clusters_spec.rb +1 -1
- data/spec/models/kubernetes_maintenance_window_spec.rb +1 -1
- data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
- data/spec/models/{kubernetes_config_spec.rb → kubernetes_node_pool_for_post_spec.rb} +14 -8
- data/spec/models/kubernetes_node_pool_for_put_spec.rb +1 -1
- data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +40 -0
- data/spec/models/kubernetes_node_pool_lan_spec.rb +13 -1
- data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +1 -1
- data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +1 -51
- data/spec/models/kubernetes_node_pool_properties_spec.rb +1 -1
- data/spec/models/kubernetes_node_pool_spec.rb +1 -1
- data/spec/models/kubernetes_node_pools_spec.rb +1 -1
- data/spec/models/kubernetes_node_properties_spec.rb +7 -1
- data/spec/models/kubernetes_node_spec.rb +2 -2
- data/spec/models/kubernetes_nodes_spec.rb +2 -2
- data/spec/models/label_properties_spec.rb +1 -1
- data/spec/models/label_resource_properties_spec.rb +1 -1
- data/spec/models/label_resource_spec.rb +1 -1
- data/spec/models/label_resources_spec.rb +2 -2
- data/spec/models/label_spec.rb +1 -1
- data/spec/models/labels_spec.rb +2 -2
- data/spec/models/lan_entities_spec.rb +1 -1
- data/spec/models/lan_nics_spec.rb +1 -1
- data/spec/models/lan_post_spec.rb +1 -1
- data/spec/models/lan_properties_post_spec.rb +1 -1
- data/spec/models/lan_properties_spec.rb +1 -1
- data/spec/models/lan_spec.rb +1 -1
- data/spec/models/lans_spec.rb +1 -1
- data/spec/models/loadbalancer_entities_spec.rb +1 -1
- data/spec/models/loadbalancer_properties_spec.rb +1 -5
- data/spec/models/loadbalancer_spec.rb +1 -1
- data/spec/models/loadbalancers_spec.rb +1 -1
- data/spec/models/location_properties_spec.rb +7 -5
- data/spec/models/location_spec.rb +1 -1
- data/spec/models/locations_spec.rb +1 -1
- data/spec/models/nat_gateway_entities_spec.rb +40 -0
- data/spec/models/nat_gateway_lan_properties_spec.rb +40 -0
- data/spec/models/nat_gateway_properties_spec.rb +46 -0
- data/spec/models/nat_gateway_put_spec.rb +52 -0
- data/spec/models/nat_gateway_rule_properties_spec.rb +70 -0
- data/spec/models/nat_gateway_rule_protocol_spec.rb +28 -0
- data/spec/models/nat_gateway_rule_put_spec.rb +52 -0
- data/spec/models/nat_gateway_rule_spec.rb +58 -0
- data/spec/models/nat_gateway_rule_type_spec.rb +28 -0
- data/spec/models/nat_gateway_rules_spec.rb +52 -0
- data/spec/models/nat_gateway_spec.rb +64 -0
- data/spec/models/nat_gateways_spec.rb +70 -0
- data/spec/models/network_load_balancer_entities_spec.rb +40 -0
- data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +58 -0
- data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +78 -0
- data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rule_spec.rb +58 -0
- data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +46 -0
- data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rules_spec.rb +70 -0
- data/spec/models/network_load_balancer_properties_spec.rb +58 -0
- data/spec/models/network_load_balancer_put_spec.rb +52 -0
- data/spec/models/network_load_balancer_spec.rb +64 -0
- data/spec/models/network_load_balancers_spec.rb +70 -0
- data/spec/models/nic_entities_spec.rb +7 -1
- data/spec/models/nic_properties_spec.rb +18 -2
- data/spec/models/nic_put_spec.rb +52 -0
- data/spec/models/nic_spec.rb +1 -1
- data/spec/models/nics_spec.rb +1 -1
- data/spec/models/no_state_meta_data_spec.rb +1 -1
- data/spec/models/pagination_links_spec.rb +1 -1
- data/spec/models/peer_spec.rb +1 -1
- data/spec/models/private_cross_connect_properties_spec.rb +1 -1
- data/spec/models/private_cross_connect_spec.rb +1 -1
- data/spec/models/private_cross_connects_spec.rb +1 -1
- data/spec/models/{kubernetes_config_properties_spec.rb → remote_console_url_spec.rb} +8 -8
- data/spec/models/request_metadata_spec.rb +1 -1
- data/spec/models/request_properties_spec.rb +1 -1
- data/spec/models/request_spec.rb +1 -1
- data/spec/models/request_status_metadata_spec.rb +1 -1
- data/spec/models/request_status_spec.rb +1 -1
- data/spec/models/request_target_spec.rb +1 -1
- data/spec/models/requests_spec.rb +1 -1
- data/spec/models/resource_entities_spec.rb +1 -1
- data/spec/models/resource_groups_spec.rb +1 -1
- data/spec/models/resource_limits_spec.rb +31 -1
- data/spec/models/resource_properties_spec.rb +1 -1
- data/spec/models/resource_reference_spec.rb +1 -1
- data/spec/models/resource_spec.rb +1 -1
- data/spec/models/resources_spec.rb +1 -1
- data/spec/models/resources_users_spec.rb +1 -1
- data/spec/models/s3_key_metadata_spec.rb +1 -1
- data/spec/models/s3_key_properties_spec.rb +1 -1
- data/spec/models/s3_key_spec.rb +1 -1
- data/spec/models/s3_keys_spec.rb +1 -1
- data/spec/models/s3_object_storage_sso_spec.rb +1 -1
- data/spec/models/server_entities_spec.rb +1 -1
- data/spec/models/server_properties_spec.rb +14 -2
- data/spec/models/server_spec.rb +1 -1
- data/spec/models/servers_spec.rb +1 -1
- data/spec/models/snapshot_properties_spec.rb +1 -1
- data/spec/models/snapshot_spec.rb +1 -1
- data/spec/models/snapshots_spec.rb +1 -1
- data/spec/models/target_port_range_spec.rb +40 -0
- data/spec/models/template_properties_spec.rb +52 -0
- data/spec/models/template_spec.rb +58 -0
- data/spec/models/templates_spec.rb +52 -0
- data/spec/models/token_spec.rb +34 -0
- data/spec/models/type_spec.rb +1 -1
- data/spec/models/user_metadata_spec.rb +1 -1
- data/spec/models/user_post_spec.rb +34 -0
- data/spec/models/user_properties_post_spec.rb +76 -0
- data/spec/models/user_properties_put_spec.rb +70 -0
- data/spec/models/user_properties_spec.rb +1 -7
- data/spec/models/user_put_spec.rb +40 -0
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/users_entities_spec.rb +1 -1
- data/spec/models/users_spec.rb +1 -1
- data/spec/models/volume_properties_spec.rb +14 -8
- data/spec/models/volume_spec.rb +1 -1
- data/spec/models/volumes_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +505 -160
- data/DOCS.md +0 -14618
- data/lib/ionoscloud/api/nic_api.rb +0 -1222
data/docs/Nic.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# Nic
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
|
11
|
+
| **properties** | [**NicProperties**](NicProperties.md) | | |
|
12
|
+
| **entities** | [**NicEntities**](NicEntities.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ionoscloud'
|
18
|
+
|
19
|
+
instance = Ionoscloud::Nic.new(
|
20
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
21
|
+
type: "nic",
|
22
|
+
href: <RESOURCE-URI>,
|
23
|
+
metadata: null,
|
24
|
+
properties: null,
|
25
|
+
entities: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
data/docs/NicEntities.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# NicEntities
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **flowlogs** | [**FlowLogs**](FlowLogs.md) | | [optional] |
|
8
|
+
| **firewallrules** | [**FirewallRules**](FirewallRules.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ionoscloud'
|
14
|
+
|
15
|
+
instance = Ionoscloud::NicEntities.new(
|
16
|
+
flowlogs: null,
|
17
|
+
firewallrules: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# NicProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A name of that resource | [optional] |
|
8
|
+
| **mac** | **String** | The MAC address of the NIC | [optional][readonly] |
|
9
|
+
| **ips** | **Array<String>** | Collection of IP addresses assigned to a nic. Explicitly assigned public IPs need to come from reserved IP blocks, Passing value null or empty array will assign an IP address automatically. | [optional] |
|
10
|
+
| **dhcp** | **Boolean** | Indicates if the nic will reserve an IP using DHCP | [optional] |
|
11
|
+
| **lan** | **Integer** | The LAN ID the NIC will sit on. If the LAN ID does not exist it will be implicitly created | |
|
12
|
+
| **firewall_active** | **Boolean** | Activate or deactivate the firewall. By default an active firewall without any defined rules will block all incoming network traffic except for the firewall rules that explicitly allows certain protocols, ip addresses and ports. | [optional] |
|
13
|
+
| **firewall_type** | **String** | The type of firewall rules that will be allowed on the NIC. If it is not specified it will take the default value INGRESS | [optional] |
|
14
|
+
| **device_number** | **Integer** | The Logical Unit Number (LUN) of the storage volume. Null if this NIC was create from CloudAPI and no DCD changes were done on the Datacenter. | [optional][readonly] |
|
15
|
+
| **pci_slot** | **Integer** | The PCI slot number of the Nic. | [optional][readonly] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'ionoscloud'
|
21
|
+
|
22
|
+
instance = Ionoscloud::NicProperties.new(
|
23
|
+
name: My resource,
|
24
|
+
mac: 00:0a:95:9d:68:16,
|
25
|
+
ips: null,
|
26
|
+
dhcp: true,
|
27
|
+
lan: 2,
|
28
|
+
firewall_active: false,
|
29
|
+
firewall_type: INGRESS,
|
30
|
+
device_number: 3,
|
31
|
+
pci_slot: 7
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
data/docs/NicPut.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# NicPut
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **properties** | [**NicProperties**](NicProperties.md) | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::NicPut.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "nic",
|
20
|
+
href: <RESOURCE-URI>,
|
21
|
+
properties: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/Nics.md
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# Nics
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<Nic>**](Nic.md) | Array of items in that collection | [optional] |
|
11
|
+
| **offset** | **Float** | the offset (if specified in the request) | [optional] |
|
12
|
+
| **limit** | **Float** | the limit (if specified in the request) | [optional] |
|
13
|
+
| **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ionoscloud'
|
19
|
+
|
20
|
+
instance = Ionoscloud::Nics.new(
|
21
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
22
|
+
type: "collection",
|
23
|
+
href: <RESOURCE-URI>,
|
24
|
+
items: null,
|
25
|
+
offset: 0,
|
26
|
+
limit: 1000,
|
27
|
+
_links: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# NoStateMetaData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **etag** | **String** | Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter. | [optional][readonly] |
|
8
|
+
| **created_date** | **Time** | The time the Resource was created | [optional][readonly] |
|
9
|
+
| **created_by** | **String** | The user who has created the resource. | [optional][readonly] |
|
10
|
+
| **created_by_user_id** | **String** | The user id of the user who has created the resource. | [optional][readonly] |
|
11
|
+
| **last_modified_date** | **Time** | The last time the resource has been modified | [optional][readonly] |
|
12
|
+
| **last_modified_by** | **String** | The user who last modified the resource. | [optional][readonly] |
|
13
|
+
| **last_modified_by_user_id** | **String** | The user id of the user who has last modified the resource. | [optional][readonly] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ionoscloud'
|
19
|
+
|
20
|
+
instance = Ionoscloud::NoStateMetaData.new(
|
21
|
+
etag: 45480eb3fbfc31f1d916c1eaa4abdcc3,
|
22
|
+
created_date: 2015-12-04T14:34:09.809Z,
|
23
|
+
created_by: user@example.com,
|
24
|
+
created_by_user_id: user@example.com,
|
25
|
+
last_modified_date: 2015-12-04T14:34:09.809Z,
|
26
|
+
last_modified_by: user@example.com,
|
27
|
+
last_modified_by_user_id: 63cef532-26fe-4a64-a4e0-de7c8a506c90
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# PaginationLinks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **prev** | **String** | URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0 | [optional][readonly] |
|
8
|
+
| **_self** | **String** | URL (with offset and limit parameters) of the current page | [optional][readonly] |
|
9
|
+
| **_next** | **String** | URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements | [optional][readonly] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ionoscloud'
|
15
|
+
|
16
|
+
instance = Ionoscloud::PaginationLinks.new(
|
17
|
+
prev: <PREVIOUS-PAGE-URI>,
|
18
|
+
_self: <THIS-PAGE-URI>,
|
19
|
+
_next: <NEXT-PAGE-URI>
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Peer.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# Peer
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
8
|
+
| **name** | **String** | | [optional] |
|
9
|
+
| **datacenter_id** | **String** | | [optional] |
|
10
|
+
| **datacenter_name** | **String** | | [optional] |
|
11
|
+
| **location** | **String** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::Peer.new(
|
19
|
+
id: null,
|
20
|
+
name: null,
|
21
|
+
datacenter_id: null,
|
22
|
+
datacenter_name: null,
|
23
|
+
location: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# PrivateCrossConnect
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
|
11
|
+
| **properties** | [**PrivateCrossConnectProperties**](PrivateCrossConnectProperties.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::PrivateCrossConnect.new(
|
19
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
20
|
+
type: "pcc",
|
21
|
+
href: <RESOURCE-URI>,
|
22
|
+
metadata: null,
|
23
|
+
properties: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# PrivateCrossConnectProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A name of that resource | [optional] |
|
8
|
+
| **description** | **String** | Human readable description | [optional] |
|
9
|
+
| **peers** | [**Array<Peer>**](Peer.md) | Read-Only attribute. Lists LAN's joined to this private cross connect | [optional][readonly] |
|
10
|
+
| **connectable_datacenters** | [**Array<ConnectableDatacenter>**](ConnectableDatacenter.md) | Read-Only attribute. Lists datacenters that can be joined to this private cross connect | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::PrivateCrossConnectProperties.new(
|
18
|
+
name: My resource,
|
19
|
+
description: Private Cross-Connect between datacenter 'A' and datacenter 'B' ,
|
20
|
+
peers: { "peers": [ { "id": "<lan-id>", "name": "<lan-name>", "datacenterId": "<dc-uuid>", "datacenterName": "<dc-name>", "location": "<de/fra>"} ] },
|
21
|
+
connectable_datacenters: { "connectableDatacenters": [ { "id": "<dc-id>", "name": "<dc-name>", "location": "<de/fra>"} ] }
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# PrivateCrossConnects
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<PrivateCrossConnect>**](PrivateCrossConnect.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::PrivateCrossConnects.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "collection",
|
20
|
+
href: <RESOURCE-URI>,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,430 @@
|
|
1
|
+
# PrivateCrossConnectsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**pccs_delete**](PrivateCrossConnectsApi.md#pccs_delete) | **DELETE** /pccs/{pccId} | Delete a Private Cross-Connect |
|
8
|
+
| [**pccs_find_by_id**](PrivateCrossConnectsApi.md#pccs_find_by_id) | **GET** /pccs/{pccId} | Retrieve a Private Cross-Connect |
|
9
|
+
| [**pccs_get**](PrivateCrossConnectsApi.md#pccs_get) | **GET** /pccs | List Private Cross-Connects |
|
10
|
+
| [**pccs_patch**](PrivateCrossConnectsApi.md#pccs_patch) | **PATCH** /pccs/{pccId} | Partially Modify a Private Cross-Connect |
|
11
|
+
| [**pccs_post**](PrivateCrossConnectsApi.md#pccs_post) | **POST** /pccs | Create a Private Cross-Connect |
|
12
|
+
|
13
|
+
|
14
|
+
## pccs_delete
|
15
|
+
|
16
|
+
> pccs_delete(pcc_id, opts)
|
17
|
+
|
18
|
+
Delete a Private Cross-Connect
|
19
|
+
|
20
|
+
Delete a private cross-connect if no datacenters are joined to the given PCC
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'ionoscloud'
|
27
|
+
# setup authorization
|
28
|
+
Ionoscloud.configure do |config|
|
29
|
+
# Configure HTTP basic authorization: Basic Authentication
|
30
|
+
config.username = 'YOUR USERNAME'
|
31
|
+
config.password = 'YOUR PASSWORD'
|
32
|
+
|
33
|
+
# Configure API key authorization: Token Authentication
|
34
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
36
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
37
|
+
end
|
38
|
+
|
39
|
+
api_instance = Ionoscloud::PrivateCrossConnectsApi.new
|
40
|
+
pcc_id = 'pcc_id_example' # String | The unique ID of the private cross-connect
|
41
|
+
opts = {
|
42
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
43
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
44
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
45
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
# Delete a Private Cross-Connect
|
49
|
+
api_instance.pccs_delete(pcc_id, opts)
|
50
|
+
rescue Ionoscloud::ApiError => e
|
51
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_delete: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
#### Using the pccs_delete_with_http_info variant
|
56
|
+
|
57
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
58
|
+
|
59
|
+
> <Array(nil, Integer, Hash)> pccs_delete_with_http_info(pcc_id, opts)
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
begin
|
63
|
+
# Delete a Private Cross-Connect
|
64
|
+
data, status_code, headers = api_instance.pccs_delete_with_http_info(pcc_id, opts)
|
65
|
+
p status_code # => 2xx
|
66
|
+
p headers # => { ... }
|
67
|
+
p data # => nil
|
68
|
+
rescue Ionoscloud::ApiError => e
|
69
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_delete_with_http_info: #{e}"
|
70
|
+
end
|
71
|
+
```
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
| Name | Type | Description | Notes |
|
76
|
+
| ---- | ---- | ----------- | ----- |
|
77
|
+
| **pcc_id** | **String** | The unique ID of the private cross-connect | |
|
78
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
79
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
80
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
81
|
+
|
82
|
+
### Return type
|
83
|
+
|
84
|
+
nil (empty response body)
|
85
|
+
|
86
|
+
### Authorization
|
87
|
+
|
88
|
+
Basic Authentication, Token Authentication
|
89
|
+
|
90
|
+
### HTTP request headers
|
91
|
+
|
92
|
+
- **Content-Type**: Not defined
|
93
|
+
- **Accept**: application/json
|
94
|
+
|
95
|
+
|
96
|
+
## pccs_find_by_id
|
97
|
+
|
98
|
+
> <PrivateCrossConnect> pccs_find_by_id(pcc_id, opts)
|
99
|
+
|
100
|
+
Retrieve a Private Cross-Connect
|
101
|
+
|
102
|
+
You can retrieve a private cross-connect by using the resource's ID. This value can be found in the response body when a private cross-connect is created or when you GET a list of private cross-connects.
|
103
|
+
|
104
|
+
### Examples
|
105
|
+
|
106
|
+
```ruby
|
107
|
+
require 'time'
|
108
|
+
require 'ionoscloud'
|
109
|
+
# setup authorization
|
110
|
+
Ionoscloud.configure do |config|
|
111
|
+
# Configure HTTP basic authorization: Basic Authentication
|
112
|
+
config.username = 'YOUR USERNAME'
|
113
|
+
config.password = 'YOUR PASSWORD'
|
114
|
+
|
115
|
+
# Configure API key authorization: Token Authentication
|
116
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
117
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
118
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
119
|
+
end
|
120
|
+
|
121
|
+
api_instance = Ionoscloud::PrivateCrossConnectsApi.new
|
122
|
+
pcc_id = 'pcc_id_example' # String | The unique ID of the private cross-connect
|
123
|
+
opts = {
|
124
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
125
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
126
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
127
|
+
}
|
128
|
+
|
129
|
+
begin
|
130
|
+
# Retrieve a Private Cross-Connect
|
131
|
+
result = api_instance.pccs_find_by_id(pcc_id, opts)
|
132
|
+
p result
|
133
|
+
rescue Ionoscloud::ApiError => e
|
134
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_find_by_id: #{e}"
|
135
|
+
end
|
136
|
+
```
|
137
|
+
|
138
|
+
#### Using the pccs_find_by_id_with_http_info variant
|
139
|
+
|
140
|
+
This returns an Array which contains the response data, status code and headers.
|
141
|
+
|
142
|
+
> <Array(<PrivateCrossConnect>, Integer, Hash)> pccs_find_by_id_with_http_info(pcc_id, opts)
|
143
|
+
|
144
|
+
```ruby
|
145
|
+
begin
|
146
|
+
# Retrieve a Private Cross-Connect
|
147
|
+
data, status_code, headers = api_instance.pccs_find_by_id_with_http_info(pcc_id, opts)
|
148
|
+
p status_code # => 2xx
|
149
|
+
p headers # => { ... }
|
150
|
+
p data # => <PrivateCrossConnect>
|
151
|
+
rescue Ionoscloud::ApiError => e
|
152
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_find_by_id_with_http_info: #{e}"
|
153
|
+
end
|
154
|
+
```
|
155
|
+
|
156
|
+
### Parameters
|
157
|
+
|
158
|
+
| Name | Type | Description | Notes |
|
159
|
+
| ---- | ---- | ----------- | ----- |
|
160
|
+
| **pcc_id** | **String** | The unique ID of the private cross-connect | |
|
161
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
162
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
163
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**PrivateCrossConnect**](PrivateCrossConnect.md)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
Basic Authentication, Token Authentication
|
172
|
+
|
173
|
+
### HTTP request headers
|
174
|
+
|
175
|
+
- **Content-Type**: Not defined
|
176
|
+
- **Accept**: application/json
|
177
|
+
|
178
|
+
|
179
|
+
## pccs_get
|
180
|
+
|
181
|
+
> <PrivateCrossConnects> pccs_get(opts)
|
182
|
+
|
183
|
+
List Private Cross-Connects
|
184
|
+
|
185
|
+
You can retrieve a complete list of private cross-connects provisioned under your account
|
186
|
+
|
187
|
+
### Examples
|
188
|
+
|
189
|
+
```ruby
|
190
|
+
require 'time'
|
191
|
+
require 'ionoscloud'
|
192
|
+
# setup authorization
|
193
|
+
Ionoscloud.configure do |config|
|
194
|
+
# Configure HTTP basic authorization: Basic Authentication
|
195
|
+
config.username = 'YOUR USERNAME'
|
196
|
+
config.password = 'YOUR PASSWORD'
|
197
|
+
|
198
|
+
# Configure API key authorization: Token Authentication
|
199
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
200
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
201
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
202
|
+
end
|
203
|
+
|
204
|
+
api_instance = Ionoscloud::PrivateCrossConnectsApi.new
|
205
|
+
opts = {
|
206
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
207
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
208
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
209
|
+
}
|
210
|
+
|
211
|
+
begin
|
212
|
+
# List Private Cross-Connects
|
213
|
+
result = api_instance.pccs_get(opts)
|
214
|
+
p result
|
215
|
+
rescue Ionoscloud::ApiError => e
|
216
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_get: #{e}"
|
217
|
+
end
|
218
|
+
```
|
219
|
+
|
220
|
+
#### Using the pccs_get_with_http_info variant
|
221
|
+
|
222
|
+
This returns an Array which contains the response data, status code and headers.
|
223
|
+
|
224
|
+
> <Array(<PrivateCrossConnects>, Integer, Hash)> pccs_get_with_http_info(opts)
|
225
|
+
|
226
|
+
```ruby
|
227
|
+
begin
|
228
|
+
# List Private Cross-Connects
|
229
|
+
data, status_code, headers = api_instance.pccs_get_with_http_info(opts)
|
230
|
+
p status_code # => 2xx
|
231
|
+
p headers # => { ... }
|
232
|
+
p data # => <PrivateCrossConnects>
|
233
|
+
rescue Ionoscloud::ApiError => e
|
234
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_get_with_http_info: #{e}"
|
235
|
+
end
|
236
|
+
```
|
237
|
+
|
238
|
+
### Parameters
|
239
|
+
|
240
|
+
| Name | Type | Description | Notes |
|
241
|
+
| ---- | ---- | ----------- | ----- |
|
242
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
243
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
244
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
245
|
+
|
246
|
+
### Return type
|
247
|
+
|
248
|
+
[**PrivateCrossConnects**](PrivateCrossConnects.md)
|
249
|
+
|
250
|
+
### Authorization
|
251
|
+
|
252
|
+
Basic Authentication, Token Authentication
|
253
|
+
|
254
|
+
### HTTP request headers
|
255
|
+
|
256
|
+
- **Content-Type**: Not defined
|
257
|
+
- **Accept**: application/json
|
258
|
+
|
259
|
+
|
260
|
+
## pccs_patch
|
261
|
+
|
262
|
+
> <PrivateCrossConnect> pccs_patch(pcc_id, pcc, opts)
|
263
|
+
|
264
|
+
Partially Modify a Private Cross-Connect
|
265
|
+
|
266
|
+
You can use update private cross-connect to re-name or update its description
|
267
|
+
|
268
|
+
### Examples
|
269
|
+
|
270
|
+
```ruby
|
271
|
+
require 'time'
|
272
|
+
require 'ionoscloud'
|
273
|
+
# setup authorization
|
274
|
+
Ionoscloud.configure do |config|
|
275
|
+
# Configure HTTP basic authorization: Basic Authentication
|
276
|
+
config.username = 'YOUR USERNAME'
|
277
|
+
config.password = 'YOUR PASSWORD'
|
278
|
+
|
279
|
+
# Configure API key authorization: Token Authentication
|
280
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
281
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
282
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
283
|
+
end
|
284
|
+
|
285
|
+
api_instance = Ionoscloud::PrivateCrossConnectsApi.new
|
286
|
+
pcc_id = 'pcc_id_example' # String | The unique ID of the private cross-connect
|
287
|
+
pcc = Ionoscloud::PrivateCrossConnectProperties.new # PrivateCrossConnectProperties | Modified properties of private cross-connect
|
288
|
+
opts = {
|
289
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
290
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
291
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
292
|
+
offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with limit for pagination)
|
293
|
+
limit: 56 # Integer | the maximum number of elements to return (use together with offset for pagination)
|
294
|
+
}
|
295
|
+
|
296
|
+
begin
|
297
|
+
# Partially Modify a Private Cross-Connect
|
298
|
+
result = api_instance.pccs_patch(pcc_id, pcc, opts)
|
299
|
+
p result
|
300
|
+
rescue Ionoscloud::ApiError => e
|
301
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_patch: #{e}"
|
302
|
+
end
|
303
|
+
```
|
304
|
+
|
305
|
+
#### Using the pccs_patch_with_http_info variant
|
306
|
+
|
307
|
+
This returns an Array which contains the response data, status code and headers.
|
308
|
+
|
309
|
+
> <Array(<PrivateCrossConnect>, Integer, Hash)> pccs_patch_with_http_info(pcc_id, pcc, opts)
|
310
|
+
|
311
|
+
```ruby
|
312
|
+
begin
|
313
|
+
# Partially Modify a Private Cross-Connect
|
314
|
+
data, status_code, headers = api_instance.pccs_patch_with_http_info(pcc_id, pcc, opts)
|
315
|
+
p status_code # => 2xx
|
316
|
+
p headers # => { ... }
|
317
|
+
p data # => <PrivateCrossConnect>
|
318
|
+
rescue Ionoscloud::ApiError => e
|
319
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_patch_with_http_info: #{e}"
|
320
|
+
end
|
321
|
+
```
|
322
|
+
|
323
|
+
### Parameters
|
324
|
+
|
325
|
+
| Name | Type | Description | Notes |
|
326
|
+
| ---- | ---- | ----------- | ----- |
|
327
|
+
| **pcc_id** | **String** | The unique ID of the private cross-connect | |
|
328
|
+
| **pcc** | [**PrivateCrossConnectProperties**](PrivateCrossConnectProperties.md) | Modified properties of private cross-connect | |
|
329
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
330
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
331
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
332
|
+
| **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with limit for pagination) | [optional][default to 0] |
|
333
|
+
| **limit** | **Integer** | the maximum number of elements to return (use together with offset for pagination) | [optional][default to 1000] |
|
334
|
+
|
335
|
+
### Return type
|
336
|
+
|
337
|
+
[**PrivateCrossConnect**](PrivateCrossConnect.md)
|
338
|
+
|
339
|
+
### Authorization
|
340
|
+
|
341
|
+
Basic Authentication, Token Authentication
|
342
|
+
|
343
|
+
### HTTP request headers
|
344
|
+
|
345
|
+
- **Content-Type**: application/json
|
346
|
+
- **Accept**: application/json
|
347
|
+
|
348
|
+
|
349
|
+
## pccs_post
|
350
|
+
|
351
|
+
> <PrivateCrossConnect> pccs_post(pcc, opts)
|
352
|
+
|
353
|
+
Create a Private Cross-Connect
|
354
|
+
|
355
|
+
You can use this POST method to create a private cross-connect.
|
356
|
+
|
357
|
+
### Examples
|
358
|
+
|
359
|
+
```ruby
|
360
|
+
require 'time'
|
361
|
+
require 'ionoscloud'
|
362
|
+
# setup authorization
|
363
|
+
Ionoscloud.configure do |config|
|
364
|
+
# Configure HTTP basic authorization: Basic Authentication
|
365
|
+
config.username = 'YOUR USERNAME'
|
366
|
+
config.password = 'YOUR PASSWORD'
|
367
|
+
|
368
|
+
# Configure API key authorization: Token Authentication
|
369
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
370
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
371
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
372
|
+
end
|
373
|
+
|
374
|
+
api_instance = Ionoscloud::PrivateCrossConnectsApi.new
|
375
|
+
pcc = Ionoscloud::PrivateCrossConnect.new({properties: Ionoscloud::PrivateCrossConnectProperties.new}) # PrivateCrossConnect | Private Cross-Connect to be created
|
376
|
+
opts = {
|
377
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
378
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
379
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
380
|
+
}
|
381
|
+
|
382
|
+
begin
|
383
|
+
# Create a Private Cross-Connect
|
384
|
+
result = api_instance.pccs_post(pcc, opts)
|
385
|
+
p result
|
386
|
+
rescue Ionoscloud::ApiError => e
|
387
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_post: #{e}"
|
388
|
+
end
|
389
|
+
```
|
390
|
+
|
391
|
+
#### Using the pccs_post_with_http_info variant
|
392
|
+
|
393
|
+
This returns an Array which contains the response data, status code and headers.
|
394
|
+
|
395
|
+
> <Array(<PrivateCrossConnect>, Integer, Hash)> pccs_post_with_http_info(pcc, opts)
|
396
|
+
|
397
|
+
```ruby
|
398
|
+
begin
|
399
|
+
# Create a Private Cross-Connect
|
400
|
+
data, status_code, headers = api_instance.pccs_post_with_http_info(pcc, opts)
|
401
|
+
p status_code # => 2xx
|
402
|
+
p headers # => { ... }
|
403
|
+
p data # => <PrivateCrossConnect>
|
404
|
+
rescue Ionoscloud::ApiError => e
|
405
|
+
puts "Error when calling PrivateCrossConnectsApi->pccs_post_with_http_info: #{e}"
|
406
|
+
end
|
407
|
+
```
|
408
|
+
|
409
|
+
### Parameters
|
410
|
+
|
411
|
+
| Name | Type | Description | Notes |
|
412
|
+
| ---- | ---- | ----------- | ----- |
|
413
|
+
| **pcc** | [**PrivateCrossConnect**](PrivateCrossConnect.md) | Private Cross-Connect to be created | |
|
414
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
415
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
416
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
417
|
+
|
418
|
+
### Return type
|
419
|
+
|
420
|
+
[**PrivateCrossConnect**](PrivateCrossConnect.md)
|
421
|
+
|
422
|
+
### Authorization
|
423
|
+
|
424
|
+
Basic Authentication, Token Authentication
|
425
|
+
|
426
|
+
### HTTP request headers
|
427
|
+
|
428
|
+
- **Content-Type**: application/json
|
429
|
+
- **Accept**: application/json
|
430
|
+
|