IONOS API Overview
Introduction
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.
API Specification Files
The following is a list of all API Specification Files provided by IONOS:
Activity Log API
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 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.
AI Model Hub
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 to use the OpenAI compabitlbe API for Chat Completions. For managing custom document collections in Vector Database please use the native model hub API.
Auth API
The Auth API allows you to manage tokens for secure access to IONOS Cloud APIs.
API Gateway
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.
CDN API
The CDN API allows users to efficiently manage and configure their CDN distributions. Through this endpoint, users can perform a wide range of tasks, including provisioning CDN distributions, configuring routing rules and setting up web application firewall (WAF).
Certificate Manager Service API
The Certificate Manager Service API allows you to conveniently provision and manage SSL certificates with IONOS services and your internal connected resources.
Cloud Billing API
The IONOS Cloud Billing API can be used to retrieve information about resource usage and invoices.
Cloud API
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.
Cloud DNS API
The Cloud DNS API allows to manage zones and records for public DNS, secondary DNS as well as DNSKeys apart from other features.
Container Registry API
The Container Registry API enables you to manage docker and OCI-compliant registries for use with your managed Kubernetes clusters.
DBaaS In-Memory DB API
The DBaaS In-Memory DB API allows you to create Redis® compatible clusters or modify existing ones.
DBaaS MariaDB API
The DBaaS MariaDB API allows you to create MariaDB database clusters or modify existing ones.
DBaaS MongoDB API
The DBaaS MongoDB API provides access to MongoDB cloud-based database platform, allowing users to manage, query, and scale MongoDB databases. DBaaS MongoDB API currently supports functions for MongoDB with more supported database software coming in the future.
DBaaS PostgreSQL API
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.
Identity API
The Identity API empowers you to manage password policies within your contract, providing detailed options for precise password management.
Logging Service API
The Logging Service API provides a visualization platform where users are able to observe, search and filter the logs and also create dashboards and alerts for their data points.
Managed Stackable Data Platform API
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).
Monitoring Service API
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.
Monitoring as a Service (Legacy) API
The Monitoring as a Service API sets alarms & alerts and retrieves alarm history.
Network File Storage API
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.
Quota API
The Quota API allows you to manage usage limits and get information about the current quota limits and usage.
Reseller API
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.
S3 Object Storage API
The S3 Object Storage API enables storage, retrieval, display and deletion of objects (or binary files) within the IONOS Cloud S3 storage offering.
VM Auto Scaling 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.
VPN Gateway API
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.
Last updated