Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Set up servers & storage, configure networks, and other IaaS solutions.
Create & modify managed PostgreSQL clusters. Log, backup, and restore individual cluster data.
Create & modify managed MongoDB clusters. Log, backup, and restore individual cluster data.
Create & modify managed MariaDB clusters. Log and backup cluster data.
Create buckets and automate object storage with our S3 compatible API.
Set up alarms and alerts and retrieve notification history for MaaS.
Manage tokens to ensure secure access to other APIs.
Monitor account-related activity under a specific contract.
Retrieve invoice information and display account resource usage.
Manage contracts and administrators under a master reseller account.
Provision and manage SSL certificates with IONOS services and your internal connected resources.
Manage docker and OCI-compliant registries for use with your managed Kubernetes clusters.
Manage DNS zones and records of your domains and subdomains on public Name Servers.
Manage open-source data apps, controlled easily through a central platform.
Regional APIs enable programmatic interaction with the platform, including creating and modifying logging pipelines.
Software Development Kits (SDKs) are the comprehensive packages that provide tools, libraries, and code samples necessary to integrate a platform into your application. SDKs streamline the development process by abstracting away the complexity of interacting with the underlying APIs, allowing you to focus on building your applications.
The IONOS Cloud SDKs offer the following key benefits:
Streamlined Integration: The IONOS Cloud SDKs provide easy-to-use libraries to simplify the integration process into your applications.
Scalability and Flexibility: IONOS Cloud SDKs let you handle growing workloads through scalability and flexibility to adapt to changing requirements.
Enhanced Security: The built-in security features and best practices implemented within the SDKs safeguard your applications and data.
Seamless Access to IONOS Services: You can easily interact with various IONOS services, such as cloud infrastructure, storage, and networking, through the intuitive APIs of our SDKs.
Increased Productivity: You can leverage pre-built functions and components to reduce the development time and effort.
Improved Performance: IONOS Cloud SDKs allow you to get consistent performance across different programming languages and platforms supported by IONOS SDKs.
Note: Older versions of IONOS CloudAPI (version 1 through version 5) are announced for End of Life
. The endpoints will be deprecated by February 1, 2024, and CloudAPI Version 6 will remain operational. You may need to update your CloudAPI implementation. The page Cloud API Upgrade Documentation describes the seamless upgrade routine as well as provides a summary of the changes between each version for further reference.
The Cloud-API allows you to perform a variety of management tasks, such as spinning up additional servers, adding volumes, adjusting networking, etc. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.
The DBaaS PostgreSQL API allows you to create PostgreSQL database clusters or modify existing ones. You have the option to migrate your existing clusters to our managed service or backup/restore logged clusters. DBaaS PostgreSQL API currently supports functions for PostgreSQL with more supported database software coming in the future.
The DBaaS MongoDB API allows you to create MongoDB database clusters or modify existing ones. You have the option to migrate your existing clusters to our managed service or backup/restore logged clusters. DBaaS MongoDB API currently supports functions for MongoDB with more supported database software coming in the future.
The DBaaS MariaDB API allows you to create MariaDB database clusters or modify existing ones.
The S3 Object Storage API enables storage, retrieval, display and deletion of objects (or binary files) within the IONOS Cloud S3 storage offering.
The Activity Log API allows contract owners and administrators to discover the log of activity under a specific contract. This makes it possible to audit user activities as well as to make changes to any resources. The activity is grouped by contract and can be refined using date ranges. Activity information is READ-ONLY so all calls made against the Activity Log API will be handled using GET requests.
The Reseller API allows you to manage contracts and their associated admin users under your master reseller account. Registration in the IONOS Cloud Partner Program is required for use of this REST based API.
The IONOS Cloud Billing API can be used to retrieve information about resource usage and invoices.
Monitoring API sets alarms & alerts and retrieves alarm history.
Certificate Manager API allows you to conveniently provision and manage SSL certificates with IONOS services and your internal connected resources.
Container Registry API enables you to manage docker and OCI-compliant registries for use with your managed Kubernetes clusters.
Cloud DNS API allows to manage zones and records for public DNS, secondary DNS as well as DNSKeys apart from other features.
04 September 2023 | Cloud DNS API section added and linked
IONOS offers multiple application programming interfaces (APIs) for interacting with and managing services in the public cloud ecosystem. One of the most prominent APIs is the IONOS CloudAPI which facilitates virtual data center resources. The latest generation of CloudAPI is version 6, which contains all features and serves as the baseline for future products and updates.
Note: Older versions of IONOS CloudAPI (version 1 through version 5) are announced for End of Life
. The endpoints will be sunset on February 1, 2024, and only CloudAPI Version 6 will remain operational.
Users running CloudAPI versions older than version 6 are advised to upgrade to the most recent version.
This documentation shall describe the procedure for upgrading from an older version to CloudAPI version 6. Furthermore, it contains information on which additional features became available in each version as well as breaking changes that require further modifications if respective API resources were used in earlier versions.
However, if you are using an IONOS-provided SDK or configuration management tool, you must use the most recent version to ensure that your SDK or configuration management tool interacts with the most recent CloudAPI. More information can be found in the respective GitHub repositories or configuration management tool hubs.
If you don't update older SDKs or configuration management tools, your integration will stop working when CloudAPI versions 1 through 5 are terminated.
Note: An update of your CloudAPI version will not change your provisioned services or virtual resources. The virtual resources will continue to run without any service interruption.
You can schedule the transition from old CloudAPI versions to new CloudAPI versions according to your business needs, but it must be completed by February 1, 2024. Following that, IONOS will deactivate all CloudAPI endpoints for all legacy versions, leaving only CloudAPI version 6 operational.
During the transition, you can use multiple versions concurrently because most API resources are compatible across CloudAPI versions. There are a few incompatible changes, which are detailed in the version description below. Based on this compatibility, you can apply updates to your implementation in a sequential and step-by-step manner (e.g., API resource by API resource or per individual REST operation).
If you are not satisfied with the results, you can just revert to the previous, older CloudAPI version and make further changes until it meets your requirements.
Your CloudAPI authentication routine remains unchanged, and all authentication options are forward and backward-compatible across all CloudAPI versions.
IONOS' CloudAPI is based on previous versions. In most cases, new CloudAPI versions have added major features. Newer versions of CloudAPI are extensions of older versions.
However, in a small number of cases, breaking changes are applied to new CloudAPI versions as well, requiring adaptations to your implementations if your implementation references respective API resources and payloads. These incompatible changes will be highlighted explicitly in the CloudAPI version listed below.
If you’re running an older version of the API, upgrade to the latest version to take advantage of new functionality or streamline responses so the API is faster for you. In most cases, upgrading your API version should be simple:
All CloudAPI HTTP methods contain the version tag in the URL.
Example of old CloudAPI Version (e.g., V2)
Scope of API Call: Create a new virtual data center by using CloudAPI Version 2
HTTP Method: POST
https://api.ionos.com/cloudapi/v2/datacenter
Note: Request payload to be added and not provided here for better readability.
To upgrade to the latest version of CloudAPI, you need to change the version tag within the HTTP call. Based on the previous example, the HTTP call would need to look like this:
Example of the latest CloudAPI Version (V6)
Scope of API Call: Create a new virtual data center by using CloudAPI Version 6
HTTP Method: POST
https://api.ionos.com/cloudapi/v6/datacenter
Note: Request payload to be added and not provided here for better readability.
Until the expiration date of CloudAPI version 1 - version 5, you can continue to use all versions of CloudAPI, giving you flexibility in your migration strategy. It is not required to migrate the entirety of your implementation to a single CloudAPI version at once. If necessary, you can run an implementation with different versions of the CloudAPI and plan the transition in iterations.
This concept makes it possible to revert to previous CloudAPI versions. Please note that you may be required to undo incompatible changes across CloudAPI versions.
Note: Any change to the CloudAPI version will not result in any changes to the configuration of your virtual infrastructure or services. They will maintain their previous configuration and status.
This section provides a summary of important changes in each CloudAPI version. If a particular CloudAPI version has introduced incompatible changes then they apply to all previous CloudAPI versions.
It is possible to upgrade from any older CloudAPI version to the latest version, 6. It is not required to iterate the upgrade process through all versions.
CloudAPI Version 6 is the latest version and will remain active. It will receive further functionalities and features but also improvements and bug fixes in the future.
Added features since CloudAPI V5
Added the optional server property type
used to provision a Compute Engine or IONOS Cubes (if the property is not provided, the default is ENTERPRISE
, which resolves to a Compute Engine).
Added the template
server property, which is required when provisioning a CUBE server.
Added the /template
resource for retrieving a list of all available CUBE templates. This template does not apply to ENTERPRISE servers.
Added the volume type DAS
(direct attached storage based on NVMe), which is automatically applied to every CUBE. This volume type cannot be provisioned independently, meaning you cannot have multiple direct-attached storages per CUBE or mount direct-attached storage volumes on ENTERPRISE server types.
Added volume type expansion for the introduction of SSD
Performance classes. SSD
is still possible but will resolve to the highest SSD performance class, which the volume type SSD_PREMIUM
can explicitly provision. To order an SSD performance class from the lower tier, the volume type must be SSD_STANDARD
. No performance class has been introduced for volumes of type HDD
or DAS
.
Added the volume property userData
, which enables cloud-init configuration injection into public Linux images.
Added /flowlogs
as a subresource of network interface cards, Managed NAT Gateways, Managed Application Load Balancers, and Managed Network Load Balancers. It specifies which network traffic will be recorded and the S3 bucket where the recordings will be stored.
Added the /natgateways
resource to the API, a Managed Network Load Balancer service (TCP/IP Layer 3 load balancer according to the OSI model).
Added the API resource /networkloadbalancers
, a Managed Network Load Balancer service (TCP/IP Layer 3 load balancer according to the OSI model).
Added the API resource /applicationloadbalancers
, a Managed Application Load Balancer service (an HTTP/HTTPS Layer 7 load balancer in accordance with the OSI model).
Added the API resource /targetgroups
, required for configuring the Managed Application Load Balancer.
Added support for bi-directional firewall configuration on network interface cards with CIDR masks.
Added exposure of PCI slot positioning of network interface cards and block storage devices for easier identification within the VM operating system.
Added the API resource /targetgroups
required for configuring the Managed Application Load Balancer.
Further, other resources or properties may be visible in the documentation or in the CloudAPI V6 swagger file but are not listed here as they are not active yet.
Deprecated/ Removed features or incompatible changes since CloudAPI V5
CloudAPI V6 is fully compatible with CloudAPI V5 and has introduced new resources, optional properties, and property values. Furthermore, no feature was deprecated from CloudAPI V5.
Note: S3 Key Management has been documented separately in the CloudAPI V6 documentation and the corresponding swagger JSON file, but neither the resource path nor its properties have changed. This revision is made solely for documentation purposes.
Added features since CloudAPI V4
Added the API resource /k8s
for managing Kubernetes clusters and node pools.
Added the API resource /backupUnits
for managing Backup groups.
Added the volume property backupUnits
to define the target of storage volume backup.
Added the API resource /s3keys
as a subresource of User Management for managing individual S3 Keys of your user and other users (depending on user role).
Added the functionality to retrieve and manage user information (depending on user role).
Added the meta attributes createdByUserId
and lastModifiedByUserId
to several resources, such as data centers, servers, volumes, etc., to help track ownership and change history by the user.
Add the API resource /labels
to manage labels and associate them with specific resources (data centers, servers, volumes, snapshots, IP blocks).
Deprecated/ Removed features or incompatible changes since CloudAPI V4
Removed the volume property allowReboot
of type boolean
and indicated whether or not a VM may be rebooted to apply a specific change. When a configuration change to a virtual resource requires a reboot, the VM must be automatically restarted for service reasons. In CloudAPI versions greater than V4, if this property is still set, the CloudAPI will return a parser error.
Incompatibly by changing a required header attribute for resellers from PB-Contract-Number
to X-Contract-Number
. This header field is required only for resellers who can interact on behalf of their respective customers in customer contracts. This field must be used to uniquely identify a contract from which a reseller wishes to retrieve information or make modifications.
Added features since CloudAPI V3
Added the API resource /um
for user management, including management of privileges and permissions.
Added query filter options to CloudAPI resources to apply server-side filtering (e.g., GET all servers of a certain CPU family in the state DEALLOCATED
).
Added the /contracts
extension to the response payload, which contains information about contract resource limits and current resource utilization.
Added the volume property imageAlias
, which allows the assignment of public images via an alias instead of a uuid
.
Added the /locations
extension to the response payload, which contains information about which image aliases are available in each location.
Added the LAN property ipFailover
to prepare failover routines by configuring the same public IP on multiple NICs within a LAN.
Deprecated/ Removed features or incompatible changes since CloudAPI V3
CloudAPI V4 is fully compatible with CloudAPI V3 and has introduced new resources, optional properties, and property values. Furthermore, no feature was deprecated from CloudAPI V3.
Added features since CloudAPI V2
Added the option to download the CloudAPI version swagger file.
Added the volume property availabilityZone
to create affinity or anti-affinity of HDD
or SSD
volumes. This property will not be supported on volumes of type DAS
introduced with CloudAPI V6 (see above).
Added REST content types for standard data representation.
Deprecated/ Removed features or incompatible changes since CloudAPI V3
Deprecated custom REST content types for data representation. Providing the custom REST content types in any CloudAPI version higher than V2 will result in an error because these types are no longer known by the API.
Added features since CloudAPI V1
Added the volume property sshKeys
(only for public Linux images) and imagePassword
(for all public images) to define root access to the operating system following the provisioning of a new operating system. One of both options must be defined when creating a new volume with a public image provided by IONOS.
Added the volume type SSD
in addition to the existing type HDD
. Please note that in CloudAPI V2, the SSD
Performance Classes option has not yet been implemented, and the corresponding property values are not supported/will result in an error.
Deprecated/ Removed features or incompatible changes since CloudAPI V1
CloudAPI V2 is fully compatible with CloudAPI V1 and has introduced new resources, optional properties, and property values. Furthermore, no feature was deprecated from CloudAPI V1.
CloudAPI V1 was the first released RESTful API for interacting with IONOS public cloud services. Therefore, there are no change logs or compatibility issues to be listed. As mentioned before, all CloudAPI versions follow its predecessor.
No. You can use any version of the CloudAPI anytime without modifying your user account or contracting yourself or through the IONOS support team.
No. All services in your infrastructure will continue to work in the exact configuration you set them up. The upgrade will only change the interface towards IONOS which allows you to manage your infrastructure and services.
After September 30, 2023, IONOS will deactivate the CloudAPI endpoints for version 1 up to version 5. Any API call to these versions will not return an error, and the respective API call does not get processed. Your infrastructure will continue to operate in the exact configuration you set them up, but you cannot add, retrieve, modify, or delete any resource anymore. As an alternative, you can use the Data Center Designer (DCD) to continue managing your infrastructure and services until you have completed your upgrade process.
You can upgrade iteratively and interact with your resources with different CloudAPI versions. For example, you may pool the status of your VM via the latest CloudAPI version already while you still manage the VM with an earlier version. You can define your upgrade schedule according to your technical needs.
Upgrading to the latest version of CloudAPI will not change any prices or service level conditions. These are independent of using any interface (DCD, API, SDKs, or Configuration Management Tools).
Yes. All resources provisioned through any interface in any version will get charged. IONOS cannot determine when you are about to upgrade or work in any particular version productively. From the perspective of IONOS, you are ordering resources that could be used for any workload and, as such, must be billed. Upgrading the CloudAPI requires minimal resources; you can delete any provisioned resource in seconds. You also can execute the upgrade without creating any resources and therefore do not create any cost to your account.
Awesome. There is no further action required.
Yes! IONOS will introduce changes to the current CloudAPI V6 as long as they do not cause breaking changes or incompatibilities. When this occurs, IONOS will release a new CloudAPI version. CloudAPI V6 will not be phased out immediately. IONOS will provide a timeline and information on whether the older API version will be continued or discontinued. You can be confident that IONOS will ensure that any transition is smooth and with adequate lead time. You may have noticed that IONOS has launched certain services in decoupled endpoints, allowing separate services to establish individual life cycles.
No. However, we may be able to assist by referring IONOS partners who can provide such services. You should contact your sales representative or key account manager about possible options.
In most cases, the upgrade will be relatively seamless, as the most significant change is made to the URL of your HTTP calls while the request and response payloads remain unchanged. Nevertheless, you may encounter difficulties. Here are some suggestions you may find helpful for initial analysis:
Check the HTTP error code; if it is 404, your basepath, including its version, is incorrect. Make sure it is https://api.ionos.com/cloudapi/v6/
. If there are additional HTTP error codes, it may be necessary to verify your credentials.
Check your firewall settings; according to IONOS support experience, applying specific restrictive configurations that define the complete API path, including the version tag, is not recommended. Ensure that the API endpoint and API version provide unrestricted access to the base path. This permits access to all IONOS APIs.
Check your resource limits; you can test your upgraded scripts before deploying them in production. Keep in mind that this will also consume resources for a brief duration. This counts against your resource limits and may leave your contract without additional resources. You should ensure that you have sufficient capacity by deleting additional resources. If your contract is short on resources, please contact support to increase your resource limits to meet your needs. IONOS does not offer a sandbox mode for its APIs.
Config Management Tools allow you to automate the management of your VDC and the surrounding infrastructure.
DevOps teams apply these infrastructure automation principles by leveraging common cloud libraries, SDKs, and APIs. DevOps teams benefit from infrastructure as code for better scalability, monitoring and efficiency.
Terraform
The IONOS provider for Terraform is used to interact with the cloud computing and storage resources provided by IONOS Cloud. Before you begin, you must subscribe to an IONOS account. The credentials you create during sign-up will be used to authenticate against the Cloud API.
Terraform currently supports our latest V5 and v6 offering.
Ansible
Ansible is an IT automation tool that allows users to configure, deploy, and orchestrate advanced tasks, such as continuous deployments, or zero downtime rolling updates. The IONOS module for Ansible leverages the IONOS Cloud API.
Docker Machine Driver
Docker Machine Driver is the official driver for Docker Machine to use with IONOS Cloud. It adds support for creating Docker Machines hosted on the IONOS Cloud.
Chef Knife plugin
Chef is a popular configuration management tool. It allows simplified configuration and maintenance of both servers and cloud provider environments through the use of common templates called recipes.
Puppet
The IONOS Puppet module allows a multi-server cloud environment using ProfitBricks resources to be deployed automatically from a Puppet manifest file.
IonosCTL is a tool to help you manage your IONOS Cloud resources directly from your terminal. IonosCTL CLI is currently under development. We are working on adding new commands and use-cases in order to support all the operations available in the Cloud API.
IONOS provides access to various software development kits () and . These applications have already been updated to run on CloudAPI version 6.
In most cases, neither the request nor the response payload changes, but the value options of a request or response property may have been expanded due to the ongoing growth of services. Please confirm by consulting the documentation.
The following section will summarize the changes in each version. However, each CloudAPI version documentation is available in the . You will find a drop-down box at the left top of the documentation website, which allows you to select the CloudAPI version of your choice for further consultation.
Configuration Management Tools are typically built on top of an SDK, and the SDK uses the CloudAPI. All IONOS SDKs and Configuration Management Tools have already been updated to use the most recent version of CloudAPI. As a result, you will need to make sure you are using the most current version of the relevant SDK or Configuration Management Tool. You can find more information in the GitHub repository or Release Documentation Hub. The relevant documentation links are provided on the .
Please contact the which will be available for further assistance.
Check the error response message you received; it could be that your HTTP request is valid, but there is an issue with the request payload (in the case of POST calls). Check to see if a property that must be set has been introduced or if a property has been modified. You may wish to consult the to determine the correct payload. We hope that all material changes have been listed. Notify the IONOS support team to receive immediate assistance if this is not the case, and the documentation will be updated accordingly.
Feel free to contact the if you encounter any other trouble during the upgrade.
Learn more about
Learn more about
Learn more about
Learn more about
Learn more about
Learn more about
If you have further questions regarding IonosCTL, please contact our .
You can simplify integration with PostgreSQL database clusters through the development kits, to ensure a seamless utilization of IONOS DBaaS services.
You can facilitate effortless integration with MongoDB database clusters to allow users to use IONOS DBaaS services in full capabilities.
You can use Cloud DNS SDKs to seamlessly integrate with IONOS Cloud DNS service. This allows you to efficiently manage DNS zones and records.
The Compute SDK wraps the Cloud API and is designed for developers who build applications in five languages: Go, Java, Ruby, Python and NodeJS. 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.
You can streamline your integration with IONOS Data Platform and leverage advanced data management with easy analytics capabilities using Data Platform SDKs.
The Auth SDK wraps the Auth API and is designed for developers who build applications in Go. 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.
The development kit used to provide seamless integration with the IONOS Certificate Manager. This allows you to conveniently provision and manage SSL certificates across connected resources.
Software Development Kits tailored to specific languages, such as GOLang, for better integration of IONOS Cloud services.
These development kits provide effortless integration with the IONOS Container Registry and allow you to enable seamless management of relevant registries.
You can use Logging Service SDKs to enhance your logging capabilities and facilitate easy integration with IONOS logging services for efficient data management.