ionoscloud 6.1.9

Python SDK for the Ionos Cloud API

Python API client for ionoscloud

IONOS 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.

Overview

The 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 & Usage

Requirements:

• Python >= 3.5

pip install

Since this package is hosted on Pypi you can install it by using:

pip install ionoscloud

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/ionos-cloud/sdk-python.git

Note: you may need to run pip with root permission: sudo pip install git+https://github.com/ionos-cloud/sdk-python.git

Then import the package:

import ionoscloud

Setuptools

Install via Setuptools.

python setup.py install --user

or sudo python setup.py install to install the package for all users

Then import the package:

import ionoscloud

NOTE: The Python SDK does not support Python 2. It only supports Python >= 3.5.

Authentication

The username and password or the 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:

import os

configuration = 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 proxies

You can use http proxies by setting the following environment variables:

• IONOS_HTTP_PROXY - proxy URL
• IONOS_HTTP_PROXY_HEADERS - proxy headers

Each line in IONOS_HTTP_PROXY_HEADERS represents 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 value

Depth

Many of the List or Get operations will accept an optional depth argument. 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 the depth argument to the maximum value.

Depth	Description
0	Only direct properties are included. Children are not included.
1	Direct properties and children's references are returned.
2	Direct properties and children's properties are returned.
3	Direct properties, children's properties, and descendants' references are returned.
4	Direct properties, children's properties, and descendants' properties are returned.
5	Returns all available properties.

Pretty

The operations will also accept an optional pretty argument. Setting this to a value of true or false controls whether the response is pretty-printed (with indentation and new lines). By default, the SDK sets the pretty argument to true.

Changing the base URL

Base URL for the HTTP operation can be changed in the following way:

import os

configuration = 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 Endpoints

All URIs are relative to https://api.ionos.com/cloudapi/v6

API Endpoints table

Class	Method	HTTP request	Description
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_delete	DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}	Delete an Application Load Balancer by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_find_by_application_load_balancer_id	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}	Get an Application Load Balancer by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_flowlogs_delete	DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}	Delete an ALB Flow Log by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}	Get an ALB Flow Log by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_flowlogs_get	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs	Get ALB Flow Logs
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_flowlogs_patch	PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}	Partially Modify an ALB Flow Log by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_flowlogs_post	POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs	Create an ALB Flow Log
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_flowlogs_put	PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}	Modify an ALB Flow Log by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_forwardingrules_delete	DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}	Delete an ALB Forwarding Rule by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}	Get an ALB Forwarding Rule by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_forwardingrules_get	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules	Get ALB Forwarding Rules
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_forwardingrules_patch	PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}	Partially modify an ALB Forwarding Rule by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_forwardingrules_post	POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules	Create an ALB Forwarding Rule
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_forwardingrules_put	PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}	Modify an ALB Forwarding Rule by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_get	GET /datacenters/{datacenterId}/applicationloadbalancers	Get Application Load Balancers
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_patch	PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}	Partially Modify an Application Load Balancer by ID
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_post	POST /datacenters/{datacenterId}/applicationloadbalancers	Create an Application Load Balancer
ApplicationLoadBalancersApi	datacenters_applicationloadbalancers_put	PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}	Modify an Application Load Balancer by ID
BackupUnitsApi	backupunits_delete	DELETE /backupunits/{backupunitId}	Delete backup units
BackupUnitsApi	backupunits_find_by_id	GET /backupunits/{backupunitId}	Retrieve backup units
BackupUnitsApi	backupunits_get	GET /backupunits	List backup units
BackupUnitsApi	backupunits_patch	PATCH /backupunits/{backupunitId}	Partially modify backup units
BackupUnitsApi	backupunits_post	POST /backupunits	Create backup units
BackupUnitsApi	backupunits_put	PUT /backupunits/{backupunitId}	Modify backup units
BackupUnitsApi	backupunits_ssourl_get	GET /backupunits/{backupunitId}/ssourl	Retrieve BU single sign-on URLs
ContractResourcesApi	contracts_get	GET /contracts	Get Contract Information
DataCentersApi	datacenters_delete	DELETE /datacenters/{datacenterId}	Delete data centers
DataCentersApi	datacenters_find_by_id	GET /datacenters/{datacenterId}	Retrieve data centers
DataCentersApi	datacenters_get	GET /datacenters	List your data centers
DataCentersApi	datacenters_patch	PATCH /datacenters/{datacenterId}	Partially modify a Data Center by ID
DataCentersApi	datacenters_post	POST /datacenters	Create a Data Center
DataCentersApi	datacenters_put	PUT /datacenters/{datacenterId}	Modify a Data Center by ID
FirewallRulesApi	datacenters_servers_nics_firewallrules_delete	DELETE /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}	Delete firewall rules
FirewallRulesApi	datacenters_servers_nics_firewallrules_find_by_id	GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}	Retrieve firewall rules
FirewallRulesApi	datacenters_servers_nics_firewallrules_get	GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules	List firewall rules
FirewallRulesApi	datacenters_servers_nics_firewallrules_patch	PATCH /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}	Partially modify firewall rules
FirewallRulesApi	datacenters_servers_nics_firewallrules_post	POST /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules	Create a Firewall Rule
FirewallRulesApi	datacenters_servers_nics_firewallrules_put	PUT /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}	Modify a Firewall Rule
FlowLogsApi	datacenters_servers_nics_flowlogs_delete	DELETE /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}	Delete Flow Logs
FlowLogsApi	datacenters_servers_nics_flowlogs_find_by_id	GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}	Retrieve Flow Logs
FlowLogsApi	datacenters_servers_nics_flowlogs_get	GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs	List Flow Logs
FlowLogsApi	datacenters_servers_nics_flowlogs_patch	PATCH /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}	Partially modify Flow Logs
FlowLogsApi	datacenters_servers_nics_flowlogs_post	POST /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs	Create a Flow Log
FlowLogsApi	datacenters_servers_nics_flowlogs_put	PUT /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}	Modify Flow Logs
IPBlocksApi	ipblocks_delete	DELETE /ipblocks/{ipblockId}	Delete IP blocks
IPBlocksApi	ipblocks_find_by_id	GET /ipblocks/{ipblockId}	Retrieve IP blocks
IPBlocksApi	ipblocks_get	GET /ipblocks	List IP blocks
IPBlocksApi	ipblocks_patch	PATCH /ipblocks/{ipblockId}	Partially modify IP blocks
IPBlocksApi	ipblocks_post	POST /ipblocks	Reserve a IP Block
IPBlocksApi	ipblocks_put	PUT /ipblocks/{ipblockId}	Modify a IP Block by ID
ImagesApi	images_delete	DELETE /images/{imageId}	Delete images
ImagesApi	images_find_by_id	GET /images/{imageId}	Retrieve images
ImagesApi	images_get	GET /images	List images
ImagesApi	images_patch	PATCH /images/{imageId}	Partially modify images
ImagesApi	images_put	PUT /images/{imageId}	Modify an Image by ID
KubernetesApi	k8s_delete	DELETE /k8s/{k8sClusterId}	Delete a Kubernetes Cluster by ID
KubernetesApi	k8s_find_by_cluster_id	GET /k8s/{k8sClusterId}	Get a Kubernetes Cluster by ID
KubernetesApi	k8s_get	GET /k8s	Get Kubernetes Clusters
KubernetesApi	k8s_kubeconfig_get	GET /k8s/{k8sClusterId}/kubeconfig	Get Kubernetes Configuration File
KubernetesApi	k8s_nodepools_delete	DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}	Delete a Kubernetes Node Pool by ID
KubernetesApi	k8s_nodepools_find_by_id	GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}	Get a Kubernetes Node Pool by ID
KubernetesApi	k8s_nodepools_get	GET /k8s/{k8sClusterId}/nodepools	Get Kubernetes Node Pools
KubernetesApi	k8s_nodepools_nodes_delete	DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}	Delete a Kubernetes Node by ID
KubernetesApi	k8s_nodepools_nodes_find_by_id	GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}	Get Kubernetes Node by ID
KubernetesApi	k8s_nodepools_nodes_get	GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes	Get Kubernetes Nodes
KubernetesApi	k8s_nodepools_nodes_replace_post	POST /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace	Recreate a Kubernetes Node by ID
KubernetesApi	k8s_nodepools_post	POST /k8s/{k8sClusterId}/nodepools	Create a Kubernetes Node Pool
KubernetesApi	k8s_nodepools_put	PUT /k8s/{k8sClusterId}/nodepools/{nodepoolId}	Modify a Kubernetes Node Pool by ID
KubernetesApi	k8s_post	POST /k8s	Create a Kubernetes Cluster
KubernetesApi	k8s_put	PUT /k8s/{k8sClusterId}	Modify a Kubernetes Cluster by ID
KubernetesApi	k8s_versions_default_get	GET /k8s/versions/default	Get Default Kubernetes Version
KubernetesApi	k8s_versions_get	GET /k8s/versions	Get Kubernetes Versions
LANsApi	datacenters_lans_delete	DELETE /datacenters/{datacenterId}/lans/{lanId}	Delete LANs
LANsApi	datacenters_lans_find_by_id	GET /datacenters/{datacenterId}/lans/{lanId}	Retrieve LANs
LANsApi	datacenters_lans_get	GET /datacenters/{datacenterId}/lans	List LANs
LANsApi	datacenters_lans_nics_find_by_id	GET /datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}	Retrieve attached NICs
LANsApi	datacenters_lans_nics_get	GET /datacenters/{datacenterId}/lans/{lanId}/nics	List LAN members
LANsApi	datacenters_lans_nics_post	POST /datacenters/{datacenterId}/lans/{lanId}/nics	Attach NICs
LANsApi	datacenters_lans_patch	PATCH /datacenters/{datacenterId}/lans/{lanId}	Partially modify LANs
LANsApi	datacenters_lans_post	POST /datacenters/{datacenterId}/lans	Create LANs
LANsApi	datacenters_lans_put	PUT /datacenters/{datacenterId}/lans/{lanId}	Modify LANs
LabelsApi	datacenters_labels_delete	DELETE /datacenters/{datacenterId}/labels/{key}	Delete data center labels
LabelsApi	datacenters_labels_find_by_key	GET /datacenters/{datacenterId}/labels/{key}	Retrieve data center labels
LabelsApi	datacenters_labels_get	GET /datacenters/{datacenterId}/labels	List data center labels
LabelsApi	datacenters_labels_post	POST /datacenters/{datacenterId}/labels	Create a Data Center Label
LabelsApi	datacenters_labels_put	PUT /datacenters/{datacenterId}/labels/{key}	Modify a Data Center Label by Key
LabelsApi	datacenters_servers_labels_delete	DELETE /datacenters/{datacenterId}/servers/{serverId}/labels/{key}	Delete server labels
LabelsApi	datacenters_servers_labels_find_by_key	GET /datacenters/{datacenterId}/servers/{serverId}/labels/{key}	Retrieve server labels
LabelsApi	datacenters_servers_labels_get	GET /datacenters/{datacenterId}/servers/{serverId}/labels	List server labels
LabelsApi	datacenters_servers_labels_post	POST /datacenters/{datacenterId}/servers/{serverId}/labels	Create a Server Label
LabelsApi	datacenters_servers_labels_put	PUT /datacenters/{datacenterId}/servers/{serverId}/labels/{key}	Modify a Server Label
LabelsApi	datacenters_volumes_labels_delete	DELETE /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}	Delete volume labels
LabelsApi	datacenters_volumes_labels_find_by_key	GET /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}	Retrieve volume labels
LabelsApi	datacenters_volumes_labels_get	GET /datacenters/{datacenterId}/volumes/{volumeId}/labels	List volume labels
LabelsApi	datacenters_volumes_labels_post	POST /datacenters/{datacenterId}/volumes/{volumeId}/labels	Create a Volume Label
LabelsApi	datacenters_volumes_labels_put	PUT /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}	Modify a Volume Label
LabelsApi	ipblocks_labels_delete	DELETE /ipblocks/{ipblockId}/labels/{key}	Delete IP block labels
LabelsApi	ipblocks_labels_find_by_key	GET /ipblocks/{ipblockId}/labels/{key}	Retrieve IP block labels
LabelsApi	ipblocks_labels_get	GET /ipblocks/{ipblockId}/labels	List IP block labels
LabelsApi	ipblocks_labels_post	POST /ipblocks/{ipblockId}/labels	Create IP block labels
LabelsApi	ipblocks_labels_put	PUT /ipblocks/{ipblockId}/labels/{key}	Modify a IP Block Label by ID
LabelsApi	labels_find_by_urn	GET /labels/{labelurn}	Retrieve labels by URN
LabelsApi	labels_get	GET /labels	List labels
LabelsApi	snapshots_labels_delete	DELETE /snapshots/{snapshotId}/labels/{key}	Delete snapshot labels
LabelsApi	snapshots_labels_find_by_key	GET /snapshots/{snapshotId}/labels/{key}	Retrieve snapshot labels
LabelsApi	snapshots_labels_get	GET /snapshots/{snapshotId}/labels	List snapshot labels
LabelsApi	snapshots_labels_post	POST /snapshots/{snapshotId}/labels	Create a Snapshot Label
LabelsApi	snapshots_labels_put	PUT /snapshots/{snapshotId}/labels/{key}	Modify a Snapshot Label by ID
LoadBalancersApi	datacenters_loadbalancers_balancednics_delete	DELETE /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}	Detach balanced NICs
LoadBalancersApi	datacenters_loadbalancers_balancednics_find_by_nic_id	GET /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}	Retrieve balanced NICs
LoadBalancersApi	datacenters_loadbalancers_balancednics_get	GET /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics	List balanced NICs
LoadBalancersApi	datacenters_loadbalancers_balancednics_post	POST /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics	Attach balanced NICs
LoadBalancersApi	datacenters_loadbalancers_delete	DELETE /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}	Delete Load Balancers
LoadBalancersApi	datacenters_loadbalancers_find_by_id	GET /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}	Retrieve Load Balancers
LoadBalancersApi	datacenters_loadbalancers_get	GET /datacenters/{datacenterId}/loadbalancers	List Load Balancers
LoadBalancersApi	datacenters_loadbalancers_patch	PATCH /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}	Partially modify Load Balancers
LoadBalancersApi	datacenters_loadbalancers_post	POST /datacenters/{datacenterId}/loadbalancers	Create a Load Balancer
LoadBalancersApi	datacenters_loadbalancers_put	PUT /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}	Modify a Load Balancer by ID
LocationsApi	locations_find_by_region_id	GET /locations/{regionId}	Get Locations within a Region
LocationsApi	locations_find_by_region_id_and_id	GET /locations/{regionId}/{locationId}	Get Location by ID
LocationsApi	locations_get	GET /locations	Get Locations
NATGatewaysApi	datacenters_natgateways_delete	DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}	Delete NAT Gateways
NATGatewaysApi	datacenters_natgateways_find_by_nat_gateway_id	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}	Retrieve NAT Gateways
NATGatewaysApi	datacenters_natgateways_flowlogs_delete	DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}	Delete NAT Gateway Flow Logs
NATGatewaysApi	datacenters_natgateways_flowlogs_find_by_flow_log_id	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}	Retrieve NAT Gateway Flow Logs
NATGatewaysApi	datacenters_natgateways_flowlogs_get	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs	List NAT Gateway Flow Logs
NATGatewaysApi	datacenters_natgateways_flowlogs_patch	PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}	Partially modify NAT Gateway Flow Logs
NATGatewaysApi	datacenters_natgateways_flowlogs_post	POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs	Create a NAT Gateway Flow Log
NATGatewaysApi	datacenters_natgateways_flowlogs_put	PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}	Modify NAT Gateway Flow Logs
NATGatewaysApi	datacenters_natgateways_get	GET /datacenters/{datacenterId}/natgateways	List NAT Gateways
NATGatewaysApi	datacenters_natgateways_patch	PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}	Partially modify NAT Gateways
NATGatewaysApi	datacenters_natgateways_post	POST /datacenters/{datacenterId}/natgateways	Create a NAT Gateway
NATGatewaysApi	datacenters_natgateways_put	PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}	Modify NAT Gateways
NATGatewaysApi	datacenters_natgateways_rules_delete	DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}	Delete NAT Gateway rules
NATGatewaysApi	datacenters_natgateways_rules_find_by_nat_gateway_rule_id	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}	Retrieve NAT Gateway rules
NATGatewaysApi	datacenters_natgateways_rules_get	GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules	List NAT Gateway rules
NATGatewaysApi	datacenters_natgateways_rules_patch	PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}	Partially Modify a NAT Gateway Rule by ID
NATGatewaysApi	datacenters_natgateways_rules_post	POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules	Create a NAT Gateway Rule
NATGatewaysApi	datacenters_natgateways_rules_put	PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}	Modify a NAT Gateway Rule by ID
NetworkLoadBalancersApi	datacenters_networkloadbalancers_delete	DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}	Delete Network Load Balancers
NetworkLoadBalancersApi	datacenters_networkloadbalancers_find_by_network_load_balancer_id	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}	Retrieve Network Load Balancers
NetworkLoadBalancersApi	datacenters_networkloadbalancers_flowlogs_delete	DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}	Delete NLB Flow Logs
NetworkLoadBalancersApi	datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}	Retrieve NLB Flow Logs
NetworkLoadBalancersApi	datacenters_networkloadbalancers_flowlogs_get	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs	List NLB Flow Logs
NetworkLoadBalancersApi	datacenters_networkloadbalancers_flowlogs_patch	PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}	Partially modify NLB Flow Logs
NetworkLoadBalancersApi	datacenters_networkloadbalancers_flowlogs_post	POST /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs	Create a NLB Flow Log
NetworkLoadBalancersApi	datacenters_networkloadbalancers_flowlogs_put	PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}	Modify NLB Flow Logs
NetworkLoadBalancersApi	datacenters_networkloadbalancers_forwardingrules_delete	DELETE /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}	Delete NLB forwarding rules
NetworkLoadBalancersApi	datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}	Retrieve NLB forwarding rules
NetworkLoadBalancersApi	datacenters_networkloadbalancers_forwardingrules_get	GET /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules	List NLB forwarding rules
NetworkLoadBalancersApi	datacenters_networkloadbalancers_forwardingrules_patch	PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}	Partially modify NLB forwarding rules
NetworkLoadBalancersApi	datacenters_networkloadbalancers_forwardingrules_post	POST /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules	Create a NLB Forwarding Rule
NetworkLoadBalancersApi	datacenters_networkloadbalancers_forwardingrules_put	PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}	Modify NLB forwarding rules
NetworkLoadBalancersApi	datacenters_networkloadbalancers_get	GET /datacenters/{datacenterId}/networkloadbalancers	List Network Load Balancers
NetworkLoadBalancersApi	datacenters_networkloadbalancers_patch	PATCH /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}	Partially modify Network Load Balancers
NetworkLoadBalancersApi	datacenters_networkloadbalancers_post	POST /datacenters/{datacenterId}/networkloadbalancers	Create a Network Load Balancer
NetworkLoadBalancersApi	datacenters_networkloadbalancers_put	PUT /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}	Modify Network Load Balancers
NetworkInterfacesApi	datacenters_servers_nics_delete	DELETE /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}	Delete NICs
NetworkInterfacesApi	datacenters_servers_nics_find_by_id	GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}	Retrieve NICs
NetworkInterfacesApi	datacenters_servers_nics_get	GET /datacenters/{datacenterId}/servers/{serverId}/nics	List NICs
NetworkInterfacesApi	datacenters_servers_nics_patch	PATCH /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}	Partially modify NICs
NetworkInterfacesApi	datacenters_servers_nics_post	POST /datacenters/{datacenterId}/servers/{serverId}/nics	Create a NIC
NetworkInterfacesApi	datacenters_servers_nics_put	PUT /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}	Modify NICs
PrivateCrossConnectsApi	pccs_delete	DELETE /pccs/{pccId}	Delete private Cross-Connects
PrivateCrossConnectsApi	pccs_find_by_id	GET /pccs/{pccId}	Retrieve private Cross-Connects
PrivateCrossConnectsApi	pccs_get	GET /pccs	List private Cross-Connects
PrivateCrossConnectsApi	pccs_patch	PATCH /pccs/{pccId}	Partially modify private Cross-Connects
PrivateCrossConnectsApi	pccs_post	POST /pccs	Create a Private Cross-Connect
RequestsApi	requests_find_by_id	GET /requests/{requestId}	Retrieve requests
RequestsApi	requests_get	GET /requests	List requests
RequestsApi	requests_status_get	GET /requests/{requestId}/status	Retrieve request status
ServersApi	datacenters_servers_cdroms_delete	DELETE /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}	Detach a CD-ROM by ID
ServersApi	datacenters_servers_cdroms_find_by_id	GET /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}	Get Attached CD-ROM by ID
ServersApi	datacenters_servers_cdroms_get	GET /datacenters/{datacenterId}/servers/{serverId}/cdroms	Get Attached CD-ROMs
ServersApi	datacenters_servers_cdroms_post	POST /datacenters/{datacenterId}/servers/{serverId}/cdroms	Attach a CD-ROM
ServersApi	datacenters_servers_delete	DELETE /datacenters/{datacenterId}/servers/{serverId}	Delete servers
ServersApi	datacenters_servers_find_by_id	GET /datacenters/{datacenterId}/servers/{serverId}	Retrieve servers by ID
ServersApi	datacenters_servers_get	GET /datacenters/{datacenterId}/servers	List servers
ServersApi	datacenters_servers_patch	PATCH /datacenters/{datacenterId}/servers/{serverId}	Partially modify servers
ServersApi	datacenters_servers_post	POST /datacenters/{datacenterId}/servers	Create a Server
ServersApi	datacenters_servers_put	PUT /datacenters/{datacenterId}/servers/{serverId}	Modify a Server by ID
ServersApi	datacenters_servers_reboot_post	POST /datacenters/{datacenterId}/servers/{serverId}/reboot	Reboot servers
ServersApi	datacenters_servers_remote_console_get	GET /datacenters/{datacenterId}/servers/{serverId}/remoteconsole	Get Remote Console link
ServersApi	datacenters_servers_resume_post	POST /datacenters/{datacenterId}/servers/{serverId}/resume	Resume a Cube Server by ID
ServersApi	datacenters_servers_start_post	POST /datacenters/{datacenterId}/servers/{serverId}/start	Start an Enterprise Server by ID
ServersApi	datacenters_servers_stop_post	POST /datacenters/{datacenterId}/servers/{serverId}/stop	Stop an Enterprise Server by ID
ServersApi	datacenters_servers_suspend_post	POST /datacenters/{datacenterId}/servers/{serverId}/suspend	Suspend a Cube Server by ID
ServersApi	datacenters_servers_token_get	GET /datacenters/{datacenterId}/servers/{serverId}/token	Get JASON Web Token
ServersApi	datacenters_servers_upgrade_post	POST /datacenters/{datacenterId}/servers/{serverId}/upgrade	Upgrade a Server by ID
ServersApi	datacenters_servers_volumes_delete	DELETE /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}	Detach a Volume by ID
ServersApi	datacenters_servers_volumes_find_by_id	GET /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}	Get Attached Volume by ID
ServersApi	datacenters_servers_volumes_get	GET /datacenters/{datacenterId}/servers/{serverId}/volumes	Get Attached Volumes
ServersApi	datacenters_servers_volumes_post	POST /datacenters/{datacenterId}/servers/{serverId}/volumes	Attach a Volume to a Server
SnapshotsApi	snapshots_delete	DELETE /snapshots/{snapshotId}	Delete snapshots
SnapshotsApi	snapshots_find_by_id	GET /snapshots/{snapshotId}	Retrieve snapshots by ID
SnapshotsApi	snapshots_get	GET /snapshots	List snapshots
SnapshotsApi	snapshots_patch	PATCH /snapshots/{snapshotId}	Partially modify snapshots
SnapshotsApi	snapshots_put	PUT /snapshots/{snapshotId}	Modify a Snapshot by ID
TargetGroupsApi	target_groups_delete	DELETE /targetgroups/{targetGroupId}	Delete a Target Group by ID
TargetGroupsApi	targetgroups_find_by_target_group_id	GET /targetgroups/{targetGroupId}	Get a Target Group by ID
TargetGroupsApi	targetgroups_get	GET /targetgroups	Get Target Groups
TargetGroupsApi	targetgroups_patch	PATCH /targetgroups/{targetGroupId}	Partially Modify a Target Group by ID
TargetGroupsApi	targetgroups_post	POST /targetgroups	Create a Target Group
TargetGroupsApi	targetgroups_put	PUT /targetgroups/{targetGroupId}	Modify a Target Group by ID
TemplatesApi	templates_find_by_id	GET /templates/{templateId}	Get Cubes Template by ID
TemplatesApi	templates_get	GET /templates	Get Cubes Templates
UserS3KeysApi	um_users_s3keys_delete	DELETE /um/users/{userId}/s3keys/{keyId}	Delete S3 keys
UserS3KeysApi	um_users_s3keys_find_by_key_id	GET /um/users/{userId}/s3keys/{keyId}	Retrieve user S3 keys by key ID
UserS3KeysApi	um_users_s3keys_get	GET /um/users/{userId}/s3keys	List user S3 keys
UserS3KeysApi	um_users_s3keys_post	POST /um/users/{userId}/s3keys	Create user S3 keys
UserS3KeysApi	um_users_s3keys_put	PUT /um/users/{userId}/s3keys/{keyId}	Modify a S3 Key by Key ID
UserS3KeysApi	um_users_s3ssourl_get	GET /um/users/{userId}/s3ssourl	Retrieve S3 single sign-on URLs
UserManagementApi	um_groups_delete	DELETE /um/groups/{groupId}	Delete groups
UserManagementApi	um_groups_find_by_id	GET /um/groups/{groupId}	Retrieve groups
UserManagementApi	um_groups_get	GET /um/groups	List all groups
UserManagementApi	um_groups_post	POST /um/groups	Create groups
UserManagementApi	um_groups_put	PUT /um/groups/{groupId}	Modify groups
UserManagementApi	um_groups_resources_get	GET /um/groups/{groupId}/resources	Retrieve group resources
UserManagementApi	um_groups_shares_delete	DELETE /um/groups/{groupId}/shares/{resourceId}	Remove group shares
UserManagementApi	um_groups_shares_find_by_resource_id	GET /um/groups/{groupId}/shares/{resourceId}	Retrieve group shares
UserManagementApi	um_groups_shares_get	GET /um/groups/{groupId}/shares	List group shares
UserManagementApi	um_groups_shares_post	POST /um/groups/{groupId}/shares/{resourceId}	Add group shares
UserManagementApi	um_groups_shares_put	PUT /um/groups/{groupId}/shares/{resourceId}	Modify group share privileges
UserManagementApi	um_groups_users_delete	DELETE /um/groups/{groupId}/users/{userId}	Remove users from groups
UserManagementApi	um_groups_users_get	GET /um/groups/{groupId}/users	List group members
UserManagementApi	um_groups_users_post	POST /um/groups/{groupId}/users	Add a Group Member
UserManagementApi	um_resources_find_by_type	GET /um/resources/{resourceType}	List resources by type
UserManagementApi	um_resources_find_by_type_and_id	GET /um/resources/{resourceType}/{resourceId}	Retrieve resources by type
UserManagementApi	um_resources_get	GET /um/resources	List all resources
UserManagementApi	um_users_delete	DELETE /um/users/{userId}	Delete users
UserManagementApi	um_users_find_by_id	GET /um/users/{userId}	Retrieve users
UserManagementApi	um_users_get	GET /um/users	List all users
UserManagementApi	um_users_groups_get	GET /um/users/{userId}/groups	Retrieve group resources by user ID
UserManagementApi	um_users_owns_get	GET /um/users/{userId}/owns	Retrieve user resources by user ID
UserManagementApi	um_users_post	POST /um/users	Create users
UserManagementApi	um_users_put	PUT /um/users/{userId}	Modify users
VolumesApi	datacenters_volumes_create_snapshot_post	POST /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot	Create volume snapshots
VolumesApi	datacenters_volumes_delete	DELETE /datacenters/{datacenterId}/volumes/{volumeId}	Delete volumes
VolumesApi	datacenters_volumes_find_by_id	GET /datacenters/{datacenterId}/volumes/{volumeId}	Retrieve volumes
VolumesApi	datacenters_volumes_get	GET /datacenters/{datacenterId}/volumes	List volumes
VolumesApi	datacenters_volumes_patch	PATCH /datacenters/{datacenterId}/volumes/{volumeId}	Partially modify volumes
VolumesApi	datacenters_volumes_post	POST /datacenters/{datacenterId}/volumes	Create a Volume
VolumesApi	datacenters_volumes_put	PUT /datacenters/{datacenterId}/volumes/{volumeId}	Modify a Volume by ID
VolumesApi	datacenters_volumes_restore_snapshot_post	POST /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot	Restore volume snapshots
Api	api_info_get	GET /	Get API information

Documentation For Models

All URIs are relative to https://api.ionos.com/cloudapi/v6

API models list

• ApplicationLoadBalancer
• ApplicationLoadBalancerEntities
• ApplicationLoadBalancerForwardingRule
• ApplicationLoadBalancerForwardingRuleProperties
• ApplicationLoadBalancerForwardingRulePut
• ApplicationLoadBalancerForwardingRules
• ApplicationLoadBalancerHttpRule
• ApplicationLoadBalancerHttpRuleCondition
• ApplicationLoadBalancerProperties
• ApplicationLoadBalancerPut
• ApplicationLoadBalancers
• AttachedVolumes
• BackupUnit
• BackupUnitProperties
• BackupUnitSSO
• BackupUnits
• BalancedNics
• Cdroms
• ConnectableDatacenter
• Contract
• ContractProperties
• Contracts
• CpuArchitectureProperties
• DataCenterEntities
• Datacenter
• DatacenterElementMetadata
• DatacenterProperties
• Datacenters
• Error
• ErrorMessage
• FirewallRule
• FirewallRules
• FirewallruleProperties
• FlowLog
• FlowLogProperties
• FlowLogPut
• FlowLogs
• Group
• GroupEntities
• GroupMembers
• GroupProperties
• GroupShare
• GroupShareProperties
• GroupShares
• GroupUsers
• Groups
• IPFailover
• Image
• ImageProperties
• Images
• Info
• IpBlock
• IpBlockProperties
• IpBlocks
• IpConsumer
• KubernetesAutoScaling
• KubernetesCluster
• KubernetesClusterEntities
• KubernetesClusterForPost
• KubernetesClusterForPut
• KubernetesClusterProperties
• KubernetesClusterPropertiesForPost
• KubernetesClusterPropertiesForPut
• KubernetesClusters
• KubernetesMaintenanceWindow
• KubernetesNode
• KubernetesNodeMetadata
• KubernetesNodePool
• KubernetesNodePoolForPost
• KubernetesNodePoolForPut
• KubernetesNodePoolLan
• KubernetesNodePoolLanRoutes
• KubernetesNodePoolProperties
• KubernetesNodePoolPropertiesForPost
• KubernetesNodePoolPropertiesForPut
• KubernetesNodePools
• KubernetesNodeProperties
• KubernetesNodes
• Label
• LabelProperties
• LabelResource
• LabelResourceProperties
• LabelResources
• Labels
• Lan
• LanEntities
• LanNics
• LanPost
• LanProperties
• LanPropertiesPost
• Lans
• Loadbalancer
• LoadbalancerEntities
• LoadbalancerProperties
• Loadbalancers
• Location
• LocationProperties
• Locations
• NatGateway
• NatGatewayEntities
• NatGatewayLanProperties
• NatGatewayProperties
• NatGatewayPut
• NatGatewayRule
• NatGatewayRuleProperties
• NatGatewayRuleProtocol
• NatGatewayRulePut
• NatGatewayRuleType
• NatGatewayRules
• NatGateways
• NetworkLoadBalancer
• NetworkLoadBalancerEntities
• NetworkLoadBalancerForwardingRule
• NetworkLoadBalancerForwardingRuleHealthCheck
• NetworkLoadBalancerForwardingRuleProperties
• NetworkLoadBalancerForwardingRulePut
• NetworkLoadBalancerForwardingRuleTarget
• NetworkLoadBalancerForwardingRuleTargetHealthCheck
• NetworkLoadBalancerForwardingRules
• NetworkLoadBalancerProperties
• NetworkLoadBalancerPut
• NetworkLoadBalancers
• Nic
• NicEntities
• NicProperties
• NicPut
• Nics
• NoStateMetaData
• PaginationLinks
• Peer
• PrivateCrossConnect
• PrivateCrossConnectProperties
• PrivateCrossConnects
• RemoteConsoleUrl
• Request
• RequestMetadata
• RequestProperties
• RequestStatus
• RequestStatusMetadata
• RequestTarget
• Requests
• Resource
• ResourceEntities
• ResourceGroups
• ResourceLimits
• ResourceProperties
• ResourceReference
• Resources
• ResourcesUsers
• S3Bucket
• S3Key
• S3KeyMetadata
• S3KeyProperties
• S3Keys
• S3ObjectStorageSSO
• Server
• ServerEntities
• ServerProperties
• Servers
• Snapshot
• SnapshotProperties
• Snapshots
• TargetGroup
• TargetGroupHealthCheck
• TargetGroupHttpHealthCheck
• TargetGroupProperties
• TargetGroupPut
• TargetGroupTarget
• TargetGroups
• TargetPortRange
• Template
• TemplateProperties
• Templates
• Token
• Type
• User
• UserMetadata
• UserPost
• UserProperties
• UserPropertiesPost
• UserPropertiesPut
• UserPut
• Users
• UsersEntities
• Volume
• VolumeProperties
• Volumes

[Back to API list] [Back to Model list]