Package: ionoscloud
Python API client for ionoscloudIONOS Enterprise-grade Infrastructure as a Service (IaaS) solutions can be managed through the Cloud API, in addition or as an alternative to the "Data Center Designer" (DCD) browser-based tool.Both methods employ consistent concepts and features, deliver similar power and flexibility, and can be used to perform a multitude of management tasks, including adding servers, volumes, configuring networks, and so on.OverviewThe IONOS Cloud SDK for Python provides you with access to the IONOS Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in Python. The SDK for Python wraps the IONOS Cloud API. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.Installation & UsageRequirements:Python >= 3.5pip installSince this package is hosted onPypiyou can install it by using:pipinstallionoscloudIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/ionos-cloud/sdk-python.gitNote: you may need to runpipwith root permission:sudo pip install git+https://github.com/ionos-cloud/sdk-python.gitThen import the package:importionoscloudSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--userorsudo python setup.py installto install the package for all usersThen import the package:importionoscloudNOTE:The Python SDK does not support Python 2. It only supports Python >= 3.5.AuthenticationThe username and passwordorthe authentication token can be manually specified when initializing the SDK client:configuration=ionoscloud.Configuration(username='YOUR_USERNAME',password='YOUR_PASSWORD',token='YOUR_TOKEN')client=ionoscloud.ApiClient(configuration)Environment variables can also be used. This is an example of how one would do that:importosconfiguration=ionoscloud.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),token=os.environ.get('IONOS_TOKEN'))client=ionoscloud.ApiClient(configuration)Warning: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.HTTP proxiesYou can use http proxies by setting the following environment variables:IONOS_HTTP_PROXY- proxy URLIONOS_HTTP_PROXY_HEADERS- proxy headersEach line inIONOS_HTTP_PROXY_HEADERSrepresents one header, where the header name and value is separated by a colon. Newline characters within a value need to be escaped. See this example:Connection: Keep-Alive
User-Info: MyID
User-Group: my long\nheader valueDepthMany of theListorGetoperations will accept an optionaldepthargument. Setting this to a value between 0 and 5 affects the amount of data that is returned. The details returned vary depending on the resource being queried, but it generally follows this pattern. By default, the SDK sets thedepthargument to the maximum value.DepthDescription0Only direct properties are included. Children are not included.1Direct properties and children's references are returned.2Direct properties and children's properties are returned.3Direct properties, children's properties, and descendants' references are returned.4Direct properties, children's properties, and descendants' properties are returned.5Returns all available properties.PrettyThe operations will also accept an optionalprettyargument. Setting this to a value oftrueorfalsecontrols whether the response is pretty-printed (with indentation and new lines). By default, the SDK sets theprettyargument totrue.Changing the base URLBase URL for the HTTP operation can be changed in the following way:importosconfiguration=ionoscloud.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),host=os.environ.get('IONOS_API_URL'),server_index=None,)client=ionoscloud.ApiClient(configuration)Certificate pinning:You can enable certificate pinning if you want to bypass the normal certificate checking procedure,
by doing the following:Set env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>You can get the sha256 fingerprint most easily from the browser by inspecting the certificate.Documentation for API EndpointsAll URIs are relative tohttps://api.ionos.com/cloudapi/v6API Endpoints tableClassMethodHTTP requestDescriptionApplicationLoadBalancersApidatacenters_applicationloadbalancers_deleteDELETE/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}Delete an Application Load Balancer by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_find_by_application_load_balancer_idGET/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}Get an Application Load Balancer by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_flowlogs_deleteDELETE/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}Delete an ALB Flow Log by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_flowlogs_find_by_flow_log_idGET/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}Get an ALB Flow Log by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_flowlogs_getGET/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogsGet ALB Flow LogsApplicationLoadBalancersApidatacenters_applicationloadbalancers_flowlogs_patchPATCH/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}Partially Modify an ALB Flow Log by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_flowlogs_postPOST/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogsCreate an ALB Flow LogApplicationLoadBalancersApidatacenters_applicationloadbalancers_flowlogs_putPUT/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}Modify an ALB Flow Log by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_forwardingrules_deleteDELETE/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}Delete an ALB Forwarding Rule by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_idGET/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}Get an ALB Forwarding Rule by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_forwardingrules_getGET/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrulesGet ALB Forwarding RulesApplicationLoadBalancersApidatacenters_applicationloadbalancers_forwardingrules_patchPATCH/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}Partially modify an ALB Forwarding Rule by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_forwardingrules_postPOST/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrulesCreate an ALB Forwarding RuleApplicationLoadBalancersApidatacenters_applicationloadbalancers_forwardingrules_putPUT/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}Modify an ALB Forwarding Rule by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_getGET/datacenters/{datacenterId}/applicationloadbalancersGet Application Load BalancersApplicationLoadBalancersApidatacenters_applicationloadbalancers_patchPATCH/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}Partially Modify an Application Load Balancer by IDApplicationLoadBalancersApidatacenters_applicationloadbalancers_postPOST/datacenters/{datacenterId}/applicationloadbalancersCreate an Application Load BalancerApplicationLoadBalancersApidatacenters_applicationloadbalancers_putPUT/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}Modify an Application Load Balancer by IDBackupUnitsApibackupunits_deleteDELETE/backupunits/{backupunitId}Delete backup unitsBackupUnitsApibackupunits_find_by_idGET/backupunits/{backupunitId}Retrieve backup unitsBackupUnitsApibackupunits_getGET/backupunitsList backup unitsBackupUnitsApibackupunits_patchPATCH/backupunits/{backupunitId}Partially modify backup unitsBackupUnitsApibackupunits_postPOST/backupunitsCreate backup unitsBackupUnitsApibackupunits_putPUT/backupunits/{backupunitId}Modify backup unitsBackupUnitsApibackupunits_ssourl_getGET/backupunits/{backupunitId}/ssourlRetrieve BU single sign-on URLsContractResourcesApicontracts_getGET/contractsGet Contract InformationDataCentersApidatacenters_deleteDELETE/datacenters/{datacenterId}Delete data centersDataCentersApidatacenters_find_by_idGET/datacenters/{datacenterId}Retrieve data centersDataCentersApidatacenters_getGET/datacentersList your data centersDataCentersApidatacenters_patchPATCH/datacenters/{datacenterId}Partially modify a Data Center by IDDataCentersApidatacenters_postPOST/datacentersCreate a Data CenterDataCentersApidatacenters_putPUT/datacenters/{datacenterId}Modify a Data Center by IDFirewallRulesApidatacenters_servers_nics_firewallrules_deleteDELETE/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}Delete firewall rulesFirewallRulesApidatacenters_servers_nics_firewallrules_find_by_idGET/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}Retrieve firewall rulesFirewallRulesApidatacenters_servers_nics_firewallrules_getGET/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrulesList firewall rulesFirewallRulesApidatacenters_servers_nics_firewallrules_patchPATCH/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}Partially modify firewall rulesFirewallRulesApidatacenters_servers_nics_firewallrules_postPOST/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrulesCreate a Firewall RuleFirewallRulesApidatacenters_servers_nics_firewallrules_putPUT/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}Modify a Firewall RuleFlowLogsApidatacenters_servers_nics_flowlogs_deleteDELETE/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}Delete Flow LogsFlowLogsApidatacenters_servers_nics_flowlogs_find_by_idGET/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}Retrieve Flow LogsFlowLogsApidatacenters_servers_nics_flowlogs_getGET/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogsList Flow LogsFlowLogsApidatacenters_servers_nics_flowlogs_patchPATCH/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}Partially modify Flow LogsFlowLogsApidatacenters_servers_nics_flowlogs_postPOST/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogsCreate a Flow LogFlowLogsApidatacenters_servers_nics_flowlogs_putPUT/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}Modify Flow LogsIPBlocksApiipblocks_deleteDELETE/ipblocks/{ipblockId}Delete IP blocksIPBlocksApiipblocks_find_by_idGET/ipblocks/{ipblockId}Retrieve IP blocksIPBlocksApiipblocks_getGET/ipblocksList IP blocksIPBlocksApiipblocks_patchPATCH/ipblocks/{ipblockId}Partially modify IP blocksIPBlocksApiipblocks_postPOST/ipblocksReserve a IP BlockIPBlocksApiipblocks_putPUT/ipblocks/{ipblockId}Modify a IP Block by IDImagesApiimages_deleteDELETE/images/{imageId}Delete imagesImagesApiimages_find_by_idGET/images/{imageId}Retrieve imagesImagesApiimages_getGET/imagesList imagesImagesApiimages_patchPATCH/images/{imageId}Partially modify imagesImagesApiimages_putPUT/images/{imageId}Modify an Image by IDKubernetesApik8s_deleteDELETE/k8s/{k8sClusterId}Delete a Kubernetes Cluster by IDKubernetesApik8s_find_by_cluster_idGET/k8s/{k8sClusterId}Get a Kubernetes Cluster by IDKubernetesApik8s_getGET/k8sGet Kubernetes ClustersKubernetesApik8s_kubeconfig_getGET/k8s/{k8sClusterId}/kubeconfigGet Kubernetes Configuration FileKubernetesApik8s_nodepools_deleteDELETE/k8s/{k8sClusterId}/nodepools/{nodepoolId}Delete a Kubernetes Node Pool by IDKubernetesApik8s_nodepools_find_by_idGET/k8s/{k8sClusterId}/nodepools/{nodepoolId}Get a Kubernetes Node Pool by IDKubernetesApik8s_nodepools_getGET/k8s/{k8sClusterId}/nodepoolsGet Kubernetes Node PoolsKubernetesApik8s_nodepools_nodes_deleteDELETE/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}Delete a Kubernetes Node by IDKubernetesApik8s_nodepools_nodes_find_by_idGET/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}Get Kubernetes Node by IDKubernetesApik8s_nodepools_nodes_getGET/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodesGet Kubernetes NodesKubernetesApik8s_nodepools_nodes_replace_postPOST/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replaceRecreate a Kubernetes Node by IDKubernetesApik8s_nodepools_postPOST/k8s/{k8sClusterId}/nodepoolsCreate a Kubernetes Node PoolKubernetesApik8s_nodepools_putPUT/k8s/{k8sClusterId}/nodepools/{nodepoolId}Modify a Kubernetes Node Pool by IDKubernetesApik8s_postPOST/k8sCreate a Kubernetes ClusterKubernetesApik8s_putPUT/k8s/{k8sClusterId}Modify a Kubernetes Cluster by IDKubernetesApik8s_versions_default_getGET/k8s/versions/defaultGet Default Kubernetes VersionKubernetesApik8s_versions_getGET/k8s/versionsGet Kubernetes VersionsLANsApidatacenters_lans_deleteDELETE/datacenters/{datacenterId}/lans/{lanId}Delete LANsLANsApidatacenters_lans_find_by_idGET/datacenters/{datacenterId}/lans/{lanId}Retrieve LANsLANsApidatacenters_lans_getGET/datacenters/{datacenterId}/lansList LANsLANsApidatacenters_lans_nics_find_by_idGET/datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}Retrieve attached NICsLANsApidatacenters_lans_nics_getGET/datacenters/{datacenterId}/lans/{lanId}/nicsList LAN membersLANsApidatacenters_lans_nics_postPOST/datacenters/{datacenterId}/lans/{lanId}/nicsAttach NICsLANsApidatacenters_lans_patchPATCH/datacenters/{datacenterId}/lans/{lanId}Partially modify LANsLANsApidatacenters_lans_postPOST/datacenters/{datacenterId}/lansCreate LANsLANsApidatacenters_lans_putPUT/datacenters/{datacenterId}/lans/{lanId}Modify LANsLabelsApidatacenters_labels_deleteDELETE/datacenters/{datacenterId}/labels/{key}Delete data center labelsLabelsApidatacenters_labels_find_by_keyGET/datacenters/{datacenterId}/labels/{key}Retrieve data center labelsLabelsApidatacenters_labels_getGET/datacenters/{datacenterId}/labelsList data center labelsLabelsApidatacenters_labels_postPOST/datacenters/{datacenterId}/labelsCreate a Data Center LabelLabelsApidatacenters_labels_putPUT/datacenters/{datacenterId}/labels/{key}Modify a Data Center Label by KeyLabelsApidatacenters_servers_labels_deleteDELETE/datacenters/{datacenterId}/servers/{serverId}/labels/{key}Delete server labelsLabelsApidatacenters_servers_labels_find_by_keyGET/datacenters/{datacenterId}/servers/{serverId}/labels/{key}Retrieve server labelsLabelsApidatacenters_servers_labels_getGET/datacenters/{datacenterId}/servers/{serverId}/labelsList server labelsLabelsApidatacenters_servers_labels_postPOST/datacenters/{datacenterId}/servers/{serverId}/labelsCreate a Server LabelLabelsApidatacenters_servers_labels_putPUT/datacenters/{datacenterId}/servers/{serverId}/labels/{key}Modify a Server LabelLabelsApidatacenters_volumes_labels_deleteDELETE/datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}Delete volume labelsLabelsApidatacenters_volumes_labels_find_by_keyGET/datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}Retrieve volume labelsLabelsApidatacenters_volumes_labels_getGET/datacenters/{datacenterId}/volumes/{volumeId}/labelsList volume labelsLabelsApidatacenters_volumes_labels_postPOST/datacenters/{datacenterId}/volumes/{volumeId}/labelsCreate a Volume LabelLabelsApidatacenters_volumes_labels_putPUT/datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}Modify a Volume LabelLabelsApiipblocks_labels_deleteDELETE/ipblocks/{ipblockId}/labels/{key}Delete IP block labelsLabelsApiipblocks_labels_find_by_keyGET/ipblocks/{ipblockId}/labels/{key}Retrieve IP block labelsLabelsApiipblocks_labels_getGET/ipblocks/{ipblockId}/labelsList IP block labelsLabelsApiipblocks_labels_postPOST/ipblocks/{ipblockId}/labelsCreate IP block labelsLabelsApiipblocks_labels_putPUT/ipblocks/{ipblockId}/labels/{key}Modify a IP Block Label by IDLabelsApilabels_find_by_urnGET/labels/{labelurn}Retrieve labels by URNLabelsApilabels_getGET/labelsList labelsLabelsApisnapshots_labels_deleteDELETE/snapshots/{snapshotId}/labels/{key}Delete snapshot labelsLabelsApisnapshots_labels_find_by_keyGET/snapshots/{snapshotId}/labels/{key}Retrieve snapshot labelsLabelsApisnapshots_labels_getGET/snapshots/{snapshotId}/labelsList snapshot labelsLabelsApisnapshots_labels_postPOST/snapshots/{snapshotId}/labelsCreate a Snapshot LabelLabelsApisnapshots_labels_putPUT/snapshots/{snapshotId}/labels/{key}Modify a Snapshot Label by IDLoadBalancersApidatacenters_loadbalancers_balancednics_deleteDELETE/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}Detach balanced NICsLoadBalancersApidatacenters_loadbalancers_balancednics_find_by_nic_idGET/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}Retrieve balanced NICsLoadBalancersApidatacenters_loadbalancers_balancednics_getGET/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednicsList balanced NICsLoadBalancersApidatacenters_loadbalancers_balancednics_postPOST/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednicsAttach balanced NICsLoadBalancersApidatacenters_loadbalancers_deleteDELETE/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}Delete Load BalancersLoadBalancersApidatacenters_loadbalancers_find_by_idGET/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}Retrieve Load BalancersLoadBalancersApidatacenters_loadbalancers_getGET/datacenters/{datacenterId}/loadbalancersList Load BalancersLoadBalancersApidatacenters_loadbalancers_patchPATCH/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}Partially modify Load BalancersLoadBalancersApidatacenters_loadbalancers_postPOST/datacenters/{datacenterId}/loadbalancersCreate a Load BalancerLoadBalancersApidatacenters_loadbalancers_putPUT/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}Modify a Load Balancer by IDLocationsApilocations_find_by_region_idGET/locations/{regionId}Get Locations within a RegionLocationsApilocations_find_by_region_id_and_idGET/locations/{regionId}/{locationId}Get Location by IDLocationsApilocations_getGET/locationsGet LocationsNATGatewaysApidatacenters_natgateways_deleteDELETE/datacenters/{datacenterId}/natgateways/{natGatewayId}Delete NAT GatewaysNATGatewaysApidatacenters_natgateways_find_by_nat_gateway_idGET/datacenters/{datacenterId}/natgateways/{natGatewayId}Retrieve NAT GatewaysNATGatewaysApidatacenters_natgateways_flowlogs_deleteDELETE/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}Delete NAT Gateway Flow LogsNATGatewaysApidatacenters_natgateways_flowlogs_find_by_flow_log_idGET/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}Retrieve NAT Gateway Flow LogsNATGatewaysApidatacenters_natgateways_flowlogs_getGET/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogsList NAT Gateway Flow LogsNATGatewaysApidatacenters_natgateways_flowlogs_patchPATCH/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}Partially modify NAT Gateway Flow LogsNATGatewaysApidatacenters_natgateways_flowlogs_postPOST/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogsCreate a NAT Gateway Flow LogNATGatewaysApidatacenters_natgateways_flowlogs_putPUT/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}Modify NAT Gateway Flow LogsNATGatewaysApidatacenters_natgateways_getGET/datacenters/{datacenterId}/natgatewaysList NAT GatewaysNATGatewaysApidatacenters_natgateways_patchPATCH/datacenters/{datacenterId}/natgateways/{natGatewayId}Partially modify NAT GatewaysNATGatewaysApidatacenters_natgateways_postPOST/datacenters/{datacenterId}/natgatewaysCreate a NAT GatewayNATGatewaysApidatacenters_natgateways_putPUT/datacenters/{datacenterId}/natgateways/{natGatewayId}Modify NAT GatewaysNATGatewaysApidatacenters_natgateways_rules_deleteDELETE/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}Delete NAT Gateway rulesNATGatewaysApidatacenters_natgateways_rules_find_by_nat_gateway_rule_idGET/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}Retrieve NAT Gateway rulesNATGatewaysApidatacenters_natgateways_rules_getGET/datacenters/{datacenterId}/natgateways/{natGatewayId}/rulesList NAT Gateway rulesNATGatewaysApidatacenters_natgateways_rules_patchPATCH/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}Partially Modify a NAT Gateway Rule by IDNATGatewaysApidatacenters_natgateways_rules_postPOST/datacenters/{datacenterId}/natgateways/{natGatewayId}/rulesCreate a NAT Gateway RuleNATGatewaysApidatacenters_natgateways_rules_putPUT/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}Modify a NAT Gateway Rule by IDNetworkLoadBalancersApidatacenters_networkloadbalancers_deleteDELETE/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}Delete Network Load BalancersNetworkLoadBalancersApidatacenters_networkloadbalancers_find_by_network_load_balancer_idGET/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}Retrieve Network Load BalancersNetworkLoadBalancersApidatacenters_networkloadbalancers_flowlogs_deleteDELETE/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}Delete NLB Flow LogsNetworkLoadBalancersApidatacenters_networkloadbalancers_flowlogs_find_by_flow_log_idGET/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}Retrieve NLB Flow LogsNetworkLoadBalancersApidatacenters_networkloadbalancers_flowlogs_getGET/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogsList NLB Flow LogsNetworkLoadBalancersApidatacenters_networkloadbalancers_flowlogs_patchPATCH/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}Partially modify NLB Flow LogsNetworkLoadBalancersApidatacenters_networkloadbalancers_flowlogs_postPOST/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogsCreate a NLB Flow LogNetworkLoadBalancersApidatacenters_networkloadbalancers_flowlogs_putPUT/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}Modify NLB Flow LogsNetworkLoadBalancersApidatacenters_networkloadbalancers_forwardingrules_deleteDELETE/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}Delete NLB forwarding rulesNetworkLoadBalancersApidatacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_idGET/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}Retrieve NLB forwarding rulesNetworkLoadBalancersApidatacenters_networkloadbalancers_forwardingrules_getGET/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrulesList NLB forwarding rulesNetworkLoadBalancersApidatacenters_networkloadbalancers_forwardingrules_patchPATCH/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}Partially modify NLB forwarding rulesNetworkLoadBalancersApidatacenters_networkloadbalancers_forwardingrules_postPOST/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrulesCreate a NLB Forwarding RuleNetworkLoadBalancersApidatacenters_networkloadbalancers_forwardingrules_putPUT/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}Modify NLB forwarding rulesNetworkLoadBalancersApidatacenters_networkloadbalancers_getGET/datacenters/{datacenterId}/networkloadbalancersList Network Load BalancersNetworkLoadBalancersApidatacenters_networkloadbalancers_patchPATCH/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}Partially modify Network Load BalancersNetworkLoadBalancersApidatacenters_networkloadbalancers_postPOST/datacenters/{datacenterId}/networkloadbalancersCreate a Network Load BalancerNetworkLoadBalancersApidatacenters_networkloadbalancers_putPUT/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}Modify Network Load BalancersNetworkInterfacesApidatacenters_servers_nics_deleteDELETE/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}Delete NICsNetworkInterfacesApidatacenters_servers_nics_find_by_idGET/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}Retrieve NICsNetworkInterfacesApidatacenters_servers_nics_getGET/datacenters/{datacenterId}/servers/{serverId}/nicsList NICsNetworkInterfacesApidatacenters_servers_nics_patchPATCH/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}Partially modify NICsNetworkInterfacesApidatacenters_servers_nics_postPOST/datacenters/{datacenterId}/servers/{serverId}/nicsCreate a NICNetworkInterfacesApidatacenters_servers_nics_putPUT/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}Modify NICsPrivateCrossConnectsApipccs_deleteDELETE/pccs/{pccId}Delete private Cross-ConnectsPrivateCrossConnectsApipccs_find_by_idGET/pccs/{pccId}Retrieve private Cross-ConnectsPrivateCrossConnectsApipccs_getGET/pccsList private Cross-ConnectsPrivateCrossConnectsApipccs_patchPATCH/pccs/{pccId}Partially modify private Cross-ConnectsPrivateCrossConnectsApipccs_postPOST/pccsCreate a Private Cross-ConnectRequestsApirequests_find_by_idGET/requests/{requestId}Retrieve requestsRequestsApirequests_getGET/requestsList requestsRequestsApirequests_status_getGET/requests/{requestId}/statusRetrieve request statusServersApidatacenters_servers_cdroms_deleteDELETE/datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}Detach a CD-ROM by IDServersApidatacenters_servers_cdroms_find_by_idGET/datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}Get Attached CD-ROM by IDServersApidatacenters_servers_cdroms_getGET/datacenters/{datacenterId}/servers/{serverId}/cdromsGet Attached CD-ROMsServersApidatacenters_servers_cdroms_postPOST/datacenters/{datacenterId}/servers/{serverId}/cdromsAttach a CD-ROMServersApidatacenters_servers_deleteDELETE/datacenters/{datacenterId}/servers/{serverId}Delete serversServersApidatacenters_servers_find_by_idGET/datacenters/{datacenterId}/servers/{serverId}Retrieve servers by IDServersApidatacenters_servers_getGET/datacenters/{datacenterId}/serversList serversServersApidatacenters_servers_patchPATCH/datacenters/{datacenterId}/servers/{serverId}Partially modify serversServersApidatacenters_servers_postPOST/datacenters/{datacenterId}/serversCreate a ServerServersApidatacenters_servers_putPUT/datacenters/{datacenterId}/servers/{serverId}Modify a Server by IDServersApidatacenters_servers_reboot_postPOST/datacenters/{datacenterId}/servers/{serverId}/rebootReboot serversServersApidatacenters_servers_remote_console_getGET/datacenters/{datacenterId}/servers/{serverId}/remoteconsoleGet Remote Console linkServersApidatacenters_servers_resume_postPOST/datacenters/{datacenterId}/servers/{serverId}/resumeResume a Cube Server by IDServersApidatacenters_servers_start_postPOST/datacenters/{datacenterId}/servers/{serverId}/startStart an Enterprise Server by IDServersApidatacenters_servers_stop_postPOST/datacenters/{datacenterId}/servers/{serverId}/stopStop an Enterprise Server by IDServersApidatacenters_servers_suspend_postPOST/datacenters/{datacenterId}/servers/{serverId}/suspendSuspend a Cube Server by IDServersApidatacenters_servers_token_getGET/datacenters/{datacenterId}/servers/{serverId}/tokenGet JASON Web TokenServersApidatacenters_servers_upgrade_postPOST/datacenters/{datacenterId}/servers/{serverId}/upgradeUpgrade a Server by IDServersApidatacenters_servers_volumes_deleteDELETE/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}Detach a Volume by IDServersApidatacenters_servers_volumes_find_by_idGET/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}Get Attached Volume by IDServersApidatacenters_servers_volumes_getGET/datacenters/{datacenterId}/servers/{serverId}/volumesGet Attached VolumesServersApidatacenters_servers_volumes_postPOST/datacenters/{datacenterId}/servers/{serverId}/volumesAttach a Volume to a ServerSnapshotsApisnapshots_deleteDELETE/snapshots/{snapshotId}Delete snapshotsSnapshotsApisnapshots_find_by_idGET/snapshots/{snapshotId}Retrieve snapshots by IDSnapshotsApisnapshots_getGET/snapshotsList snapshotsSnapshotsApisnapshots_patchPATCH/snapshots/{snapshotId}Partially modify snapshotsSnapshotsApisnapshots_putPUT/snapshots/{snapshotId}Modify a Snapshot by IDTargetGroupsApitarget_groups_deleteDELETE/targetgroups/{targetGroupId}Delete a Target Group by IDTargetGroupsApitargetgroups_find_by_target_group_idGET/targetgroups/{targetGroupId}Get a Target Group by IDTargetGroupsApitargetgroups_getGET/targetgroupsGet Target GroupsTargetGroupsApitargetgroups_patchPATCH/targetgroups/{targetGroupId}Partially Modify a Target Group by IDTargetGroupsApitargetgroups_postPOST/targetgroupsCreate a Target GroupTargetGroupsApitargetgroups_putPUT/targetgroups/{targetGroupId}Modify a Target Group by IDTemplatesApitemplates_find_by_idGET/templates/{templateId}Get Cubes Template by IDTemplatesApitemplates_getGET/templatesGet Cubes TemplatesUserS3KeysApium_users_s3keys_deleteDELETE/um/users/{userId}/s3keys/{keyId}Delete S3 keysUserS3KeysApium_users_s3keys_find_by_key_idGET/um/users/{userId}/s3keys/{keyId}Retrieve user S3 keys by key IDUserS3KeysApium_users_s3keys_getGET/um/users/{userId}/s3keysList user S3 keysUserS3KeysApium_users_s3keys_postPOST/um/users/{userId}/s3keysCreate user S3 keysUserS3KeysApium_users_s3keys_putPUT/um/users/{userId}/s3keys/{keyId}Modify a S3 Key by Key IDUserS3KeysApium_users_s3ssourl_getGET/um/users/{userId}/s3ssourlRetrieve S3 single sign-on URLsUserManagementApium_groups_deleteDELETE/um/groups/{groupId}Delete groupsUserManagementApium_groups_find_by_idGET/um/groups/{groupId}Retrieve groupsUserManagementApium_groups_getGET/um/groupsList all groupsUserManagementApium_groups_postPOST/um/groupsCreate groupsUserManagementApium_groups_putPUT/um/groups/{groupId}Modify groupsUserManagementApium_groups_resources_getGET/um/groups/{groupId}/resourcesRetrieve group resourcesUserManagementApium_groups_shares_deleteDELETE/um/groups/{groupId}/shares/{resourceId}Remove group sharesUserManagementApium_groups_shares_find_by_resource_idGET/um/groups/{groupId}/shares/{resourceId}Retrieve group sharesUserManagementApium_groups_shares_getGET/um/groups/{groupId}/sharesList group sharesUserManagementApium_groups_shares_postPOST/um/groups/{groupId}/shares/{resourceId}Add group sharesUserManagementApium_groups_shares_putPUT/um/groups/{groupId}/shares/{resourceId}Modify group share privilegesUserManagementApium_groups_users_deleteDELETE/um/groups/{groupId}/users/{userId}Remove users from groupsUserManagementApium_groups_users_getGET/um/groups/{groupId}/usersList group membersUserManagementApium_groups_users_postPOST/um/groups/{groupId}/usersAdd a Group MemberUserManagementApium_resources_find_by_typeGET/um/resources/{resourceType}List resources by typeUserManagementApium_resources_find_by_type_and_idGET/um/resources/{resourceType}/{resourceId}Retrieve resources by typeUserManagementApium_resources_getGET/um/resourcesList all resourcesUserManagementApium_users_deleteDELETE/um/users/{userId}Delete usersUserManagementApium_users_find_by_idGET/um/users/{userId}Retrieve usersUserManagementApium_users_getGET/um/usersList all usersUserManagementApium_users_groups_getGET/um/users/{userId}/groupsRetrieve group resources by user IDUserManagementApium_users_owns_getGET/um/users/{userId}/ownsRetrieve user resources by user IDUserManagementApium_users_postPOST/um/usersCreate usersUserManagementApium_users_putPUT/um/users/{userId}Modify usersVolumesApidatacenters_volumes_create_snapshot_postPOST/datacenters/{datacenterId}/volumes/{volumeId}/create-snapshotCreate volume snapshotsVolumesApidatacenters_volumes_deleteDELETE/datacenters/{datacenterId}/volumes/{volumeId}Delete volumesVolumesApidatacenters_volumes_find_by_idGET/datacenters/{datacenterId}/volumes/{volumeId}Retrieve volumesVolumesApidatacenters_volumes_getGET/datacenters/{datacenterId}/volumesList volumesVolumesApidatacenters_volumes_patchPATCH/datacenters/{datacenterId}/volumes/{volumeId}Partially modify volumesVolumesApidatacenters_volumes_postPOST/datacenters/{datacenterId}/volumesCreate a VolumeVolumesApidatacenters_volumes_putPUT/datacenters/{datacenterId}/volumes/{volumeId}Modify a Volume by IDVolumesApidatacenters_volumes_restore_snapshot_postPOST/datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshotRestore volume snapshotsApiapi_info_getGET/Get API informationDocumentation For ModelsAll URIs are relative tohttps://api.ionos.com/cloudapi/v6API models listApplicationLoadBalancerApplicationLoadBalancerEntitiesApplicationLoadBalancerForwardingRuleApplicationLoadBalancerForwardingRulePropertiesApplicationLoadBalancerForwardingRulePutApplicationLoadBalancerForwardingRulesApplicationLoadBalancerHttpRuleApplicationLoadBalancerHttpRuleConditionApplicationLoadBalancerPropertiesApplicationLoadBalancerPutApplicationLoadBalancersAttachedVolumesBackupUnitBackupUnitPropertiesBackupUnitSSOBackupUnitsBalancedNicsCdromsConnectableDatacenterContractContractPropertiesContractsCpuArchitecturePropertiesDataCenterEntitiesDatacenterDatacenterElementMetadataDatacenterPropertiesDatacentersErrorErrorMessageFirewallRuleFirewallRulesFirewallrulePropertiesFlowLogFlowLogPropertiesFlowLogPutFlowLogsGroupGroupEntitiesGroupMembersGroupPropertiesGroupShareGroupSharePropertiesGroupSharesGroupUsersGroupsIPFailoverImageImagePropertiesImagesInfoIpBlockIpBlockPropertiesIpBlocksIpConsumerKubernetesAutoScalingKubernetesClusterKubernetesClusterEntitiesKubernetesClusterForPostKubernetesClusterForPutKubernetesClusterPropertiesKubernetesClusterPropertiesForPostKubernetesClusterPropertiesForPutKubernetesClustersKubernetesMaintenanceWindowKubernetesNodeKubernetesNodeMetadataKubernetesNodePoolKubernetesNodePoolForPostKubernetesNodePoolForPutKubernetesNodePoolLanKubernetesNodePoolLanRoutesKubernetesNodePoolPropertiesKubernetesNodePoolPropertiesForPostKubernetesNodePoolPropertiesForPutKubernetesNodePoolsKubernetesNodePropertiesKubernetesNodesLabelLabelPropertiesLabelResourceLabelResourcePropertiesLabelResourcesLabelsLanLanEntitiesLanNicsLanPostLanPropertiesLanPropertiesPostLansLoadbalancerLoadbalancerEntitiesLoadbalancerPropertiesLoadbalancersLocationLocationPropertiesLocationsNatGatewayNatGatewayEntitiesNatGatewayLanPropertiesNatGatewayPropertiesNatGatewayPutNatGatewayRuleNatGatewayRulePropertiesNatGatewayRuleProtocolNatGatewayRulePutNatGatewayRuleTypeNatGatewayRulesNatGatewaysNetworkLoadBalancerNetworkLoadBalancerEntitiesNetworkLoadBalancerForwardingRuleNetworkLoadBalancerForwardingRuleHealthCheckNetworkLoadBalancerForwardingRulePropertiesNetworkLoadBalancerForwardingRulePutNetworkLoadBalancerForwardingRuleTargetNetworkLoadBalancerForwardingRuleTargetHealthCheckNetworkLoadBalancerForwardingRulesNetworkLoadBalancerPropertiesNetworkLoadBalancerPutNetworkLoadBalancersNicNicEntitiesNicPropertiesNicPutNicsNoStateMetaDataPaginationLinksPeerPrivateCrossConnectPrivateCrossConnectPropertiesPrivateCrossConnectsRemoteConsoleUrlRequestRequestMetadataRequestPropertiesRequestStatusRequestStatusMetadataRequestTargetRequestsResourceResourceEntitiesResourceGroupsResourceLimitsResourcePropertiesResourceReferenceResourcesResourcesUsersS3BucketS3KeyS3KeyMetadataS3KeyPropertiesS3KeysS3ObjectStorageSSOServerServerEntitiesServerPropertiesServersSnapshotSnapshotPropertiesSnapshotsTargetGroupTargetGroupHealthCheckTargetGroupHttpHealthCheckTargetGroupPropertiesTargetGroupPutTargetGroupTargetTargetGroupsTargetPortRangeTemplateTemplatePropertiesTemplatesTokenTypeUserUserMetadataUserPostUserPropertiesUserPropertiesPostUserPropertiesPutUserPutUsersUsersEntitiesVolumeVolumePropertiesVolumes[Back to API list][Back to Model list]