Learn how to use the IONOS Cloud API and begin integrating them to leverage the capabilities of IONOS Cloud services through this guide.

Base URL

Provide the Base URL of the IONOS API. Example: https://api.ionos.com/

Authorization

To log in to the IONOS API, you need to use either of the following authentication methods:

HTTP status codes

The IONOS APIs use the following standard HTTP response codes:

Supported version and authorization methods

Request schema

It is the format of the data that is being sent in the request body when interacting with an API endpoint. Request schema has all expected properties, data types, and constraints or validations that should be applied to the request payload. The request schema is specified using JSON Schema or another schema definition language supported by OpenAPI.

Path parameters

Path parameters allow dynamic routing, and you can request different resources using a common endpoint structure. This does not include the host or base path of the API. For example, in /datacenter/{datacenterId}, the path parameter is datacenterId.

Query parameters

Parameters that are appended to the URL to customize the request and filter data. For example, in /datacenters?depth=###, the query parameter is depth.

Header parameters

Custom headers are expected as part of the request and are sent in the header section. They are usually used for authentication tokens, content type negotiation, caching directives, and other metadata related to the request. HTTP Headers are an important part of the API request and response as they represent the meta-data associated with the API request and response.

For IONOS Object Storage, the headers carry information that is compatible with the S3 standard and, therefore, may require specific headers for certain operations.

The following IONOS APIs use the header parameters:

The following is the description of the header parameters used in IONOS APIs:

Request body

The request body is described using a schema that defines the structure and format of the data expected in the body of the request. This schema can include parameters, JSON, XML, or other data formats specific to the API design. This data is then sent by the client to the server in an HTTP request.

Request

For example, for GET request for /cloudapi/v6/datacenters API, we have the following request body sample:

 {
   "properties":{
      "name":"Test resource",
      "description":"My Production Datacenter",
      "location":"us/las",
      "secAuthProtection":false
   },
   "entities":{
      "servers":{
         "_links":{
            
         }
      },
      "volumes":{
         "_links":{
            
         }
      },
      "loadbalancers":{
         "_links":{
            
         }
      },
      "lans":{
         "_links":{
            
         }
      }
   }
}

Response

Once the datacenter resource is created, you will get a response.

{
  "id": "xxxxea-0002-9925-X1X2-aXUAUnnana",
  "type": "datacenter",
  "href": "https://api.ionos.com/cloudapi/v6/datacenters/xxxxea-0002-9925-X1X2-aXUAUnnana",
  "metadata": {
    "etag": "xxxuxea-0002-9925-X1X2-aXUAUnnanahaha",
    "createdDate": "2024-03-27T14:06:49Z",
    "createdBy": "[email protected]",
    "createdByUserId": "xgaga-1c1d-4387-iaif1-6ee95d30e54a",
    "lastModifiedDate": "2024-03-27T14:06:49Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "xgaga-1c1d-4387-iaif1-6ee95d30e54a",
    "state": "BUSY"
  },
  "properties": {
    "name": "Test resource",
    "description": "My Production Datacenter",
    "location": "us/las",
    "version": null,
    "features": [],
    "secAuthProtection": false,
    "cpuArchitecture": [],
    "ipv6CidrBlock": null
  },
  "entities": {
    "servers": {
      "id": "850bd18e-3602-4b25-b1b2-a6b3eb3a41f8/servers",
      "type": "collection",
      "href": "https://api.ionos.com/cloudapi/v6/datacenters/xxxxea-0002-9925-X1X2-aXUAUnnana/servers",
      "_links": {}
    },
    "volumes": {
      "id": "850bd18e-3602-4b25-b1b2-a6b3eb3a41f8/volumes",
      "type": "collection",
      "href": "https://api.ionos.com/cloudapi/v6/datacenters/xxxxea-0002-9925-X1X2-aXUAUnnana/volumes",
      "_links": {}
    },
    "loadbalancers": {
      "id": "850bd18e-3602-4b25-b1b2-a6b3eb3a41f8/loadbalancers",
      "type": "collection",
      "href": "https://api.ionos.com/cloudapi/v6/datacenters/xxuxea-0002-9925-X1X2-aXUAUnnanahaha/loadbalancers",
      "_links": {}
    },
    "lans": {
      "id": "850bd18e-3602-4b25-b1b2-a6b3eb3a41f8/lans",
      "type": "collection",
      "href": "https://api.ionos.com/cloudapi/v6/datacenters/xxuxea-0002-9925-X1X2-aXUAUnnanahaha/lans",
      "_links": {}
    }
  }
}

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.

Benefits

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.

You can streamline your integration with IONOS Data Platform and leverage advanced data management with easy analytics capabilities using Data Platform SDKs.

You can use Logging Service SDKs to enhance your logging capabilities and facilitate easy integration with IONOS logging services for efficient data management.

You can simplify integration with MariaDB database clusters and enable seamless utilization of IONOS DBaaS services using MariaDB SDKs.

These development kits provide effortless integration with the IONOS Container Registry and allow you to enable seamless management of relevant registries.

Software Development Kits tailored to specific languages, such as GOLang, for better integration of IONOS Cloud services.

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.

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

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.

Learn about IONOS APIs, SDKs, and Configuration Management tools. Empower your innovation with our developer-friendly tools and resources.

Application Programming Interfaces (APIs)

IONOS Infrastructure as a Service (IaaS) solutions can be managed through APIs, in addition to the Data Center Designer (DCD) web-based application. The IONOS API provides consistent concepts and features, delivers power and flexibility, and can be used to perform a multitude of management tasks, including adding servers and volumes and configuring networks. This API enables programmatic access to manage and control various aspects of cloud infrastructure. You can start using the IONOS APIs directly after getting authenticated. For more information, see Get Started with IONOS Cloud API.

Software Development Kits (SDKs)

IONOS Cloud SDKs provide a set of libraries to allow a seamless integration with IONOS services, and provide all the components needed to streamline the development process. The built-in security features and best practices implemented within the SDKs safeguard your applications and data. For more information, see SDK Bundles Documentation.

Configuration Management Tools

IONOS offers a comprehensive suite of Configuration Management Tools providing users with solutions for seamless integration and efficient management of their cloud resources. The Configuration Management Tools provide all utilities required to simplify and automate resource management that allows users to gain the ability to efficiently provision, configure, and manage their infrastructure. You can ensure configuration consistency across environments and effectively manage your cloud infrastructure in a scalable manner. For more information, see Configuration Management Tools Documentation.

Welcome to the Core API Specification for IONOS Cloud services. This guide provides detailed information about the APIs IONOS offers, allowing you to manage and interact with your cloud resources effectively. If you want to provision servers, manage databases, monitor activities, or handle billing, IONOS APIs offer the functionality to streamline all these operations.

API Specification Files

The following is a list of all API Specification Files:

AI

Compute Services

Containers

Data Analytics

Databases

Network Services

Observability

Storage & Backup

Security

Management

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.

The following third-party tools are supported:

IonosCTL CLI

IonosCTL is a tool for managing your IONOS Cloud resources directly from your terminal. The IonosCTL CLI is currently under development. We are working on adding new commands and use cases to support all the operations available in the Cloud API.

Learn more about

Relevant Links