IONOS API Overview
Last updated
Last updated
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.
Note: You can find detailed information about each API within this specification, including endpoints, functionalities, and usage instructions. Access the links to the documentation for each API to dive deeper into the specifics as needed. For more information, see our Get Started with IONOS API guide to help you begin using our APIs.
The following is a list of all API Specification Files provided by IONOS:
The Activity Log API allows contract administrators and owners to discover the log of activity under a specific contract. This makes it possible to audit user activities and make changes to resources. The activity is grouped by contract and can be refined using date ranges. Activity information is READ-ONLY, so all calls against the Activity Log API will be handled using GET requests.
The API to interact with various AI models running on the IONOS Cloud. You can enhance your applications' capabilities by leveraging managed foundation models, vector databases, and advanced retrieval augmented generation techniques. We strongly recommend using the OpenAI-compatible API for chat completions. To manage custom document collections in the Vector Database, please use the native model hub API.
The Auth API allows you to manage tokens for secure access to IONOS Cloud APIs.
The API Gateway endpoint allows users to efficiently manage and configure their API gateway instances. Through this endpoint, users can perform a wide range of tasks, including deploying API gateways, configuring API routes, setting up custom domains and implement traffic policies.
The CDN API allows users to manage and configure their CDN distributions efficiently. This endpoint allows users to perform a wide range of tasks, including provisioning CDN distributions, configuring routing rules, and setting up web application firewall (WAF).
The Certificate Manager Service API allows you to conveniently provision and manage SSL certificates with IONOS services and your internal connected resources.
The IONOS Cloud Billing API can be used to retrieve information about resource usage and invoices.
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 Cloud DNS API, among other features, allows you to manage zones and records for public DNS, secondary DNS, and DNSKeys.
The Container Registry API enables you to manage docker and OCI-compliant registries for use with your managed Kubernetes clusters.
The DBaaS In-Memory DB API allows you to create Redis® compatible clusters or modify existing ones.
The DBaaS MariaDB API allows you to create MariaDB database clusters or modify existing ones.
The DBaaS MongoDB API provides access to the MongoDB cloud-based database platform, allowing users to manage, query, and scale MongoDB databases. The API currently supports functions for MongoDB, and more database software will be supported in the future.
The DBaaS PostgreSQL API allows you to create or modify PostgreSQL database clusters. You can also migrate your existing clusters to our managed service or backup/restore logged clusters. The API currently supports functions for PostgreSQL, and more supported database software will be added in the future.
The Identity API empowers you to manage password policies within your contract, providing detailed options for precise password management.
The IONOS Object Storage API enables storage, retrieval, display and deletion of objects (or binary files) within the IONOS Object Storage offering.
The Logging Service API provides a visualization platform where users can observe, search, and filter the logs and create dashboards and alerts for their data points.
The Managed Stackable Data Platform API by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the Data Center Designer (DCD).
The Monitoring Service API provides a visualization platform where users are able to ingest, aggregate and analyze data to enhance understanding of system's performance and behavior.
The Monitoring as a Service API sets alarms & alerts and retrieves alarm history.
The Network File Storage API is the RESTful API for managing Network File Storage, a managed service that offers shared file storage for multiple virtual machines and containerized workloads via the NFS protocol.
The Quota API allows you to manage usage limits and get information about the current quota limits and usage.
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 VM Auto Scaling API enables IONOS clients to horizontally scale the number of VM replicas based on configured rules. You can use VM Auto Scaling to ensure that you have a sufficient number of replicas to handle your application loads at all times.
The VPN Gateway API allows users to efficiently manage and configure their IPSec and WireGuard based VPN Gateways. Through this endpoint, users can perform a wide range of tasks, including provisioning VPN gateways, configuring IPSec tunnels and configuring WireGuard peers.