> For the complete documentation index, see [llms.txt](https://docs.ionos.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/api-reference/readme.md).

# IONOS Cloud API Reference

Use these APIs to provision compute, storage, networking, databases, and observability resources.

* **Common base URL:** `https://api.ionos.com/`
* **Auth:** `Authorization: Bearer <access_token>` (see Getting Started)

{% hint style="info" %}
Start with [Getting Started](/api-reference/readme/getting-started.md) for base URLs, authentication, and your first request.
{% endhint %}

### Start here

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Getting Started</strong></mark></td><td>Base URL, token generation, and a working <code>curl</code> example.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/LCNbcnZHZv6MBScO9VTO">/spaces/7UCOMsy4OdTiBAQDMD27/pages/LCNbcnZHZv6MBScO9VTO</a></td></tr><tr><td><mark style="color:blue;"><strong>Authentication (Auth API)</strong></mark></td><td>Generate access tokens for API calls.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/TEzfX2w4I8ucO8oLXL3g">/spaces/7UCOMsy4OdTiBAQDMD27/pages/TEzfX2w4I8ucO8oLXL3g</a></td></tr><tr><td><mark style="color:blue;"><strong>Cloud API v6</strong></mark></td><td>Core cloud resources like datacenters, servers, and volumes.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/hlPsa0fr92Yx1e4yFHsC">/spaces/7UCOMsy4OdTiBAQDMD27/pages/hlPsa0fr92Yx1e4yFHsC</a></td></tr></tbody></table>

### Browse APIs by product

Pick a product API below.

Each API doc includes its base URL, supported auth method, version, and endpoints.

#### AI

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>AI Model Hub API</strong></mark></td><td>Interact with AI models on IONOS Cloud.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/knHA0WCUOOqZcGB7q7GA">/spaces/7UCOMsy4OdTiBAQDMD27/pages/knHA0WCUOOqZcGB7q7GA</a></td></tr><tr><td><mark style="color:blue;"><strong>AI Model Hub OpenAI API</strong></mark></td><td>OpenAI-compatible API for chat completions.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/1Ra9cEwPCcRXKizzou5x">/spaces/7UCOMsy4OdTiBAQDMD27/pages/1Ra9cEwPCcRXKizzou5x</a></td></tr></tbody></table>

#### Compute Services

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Compute Engine</strong></mark></td><td>Provision and manage virtual machines and core compute resources.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/Z0EaKzVqMf05tJmqQRjL">/spaces/7UCOMsy4OdTiBAQDMD27/pages/Z0EaKzVqMf05tJmqQRjL</a></td></tr><tr><td><mark style="color:blue;"><strong>Cubes</strong></mark></td><td>Manage cube instances.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/wBKMiisDXvaNV3BYJK5Y">/spaces/7UCOMsy4OdTiBAQDMD27/pages/wBKMiisDXvaNV3BYJK5Y</a></td></tr><tr><td><mark style="color:blue;"><strong>Cloud GPU VMs</strong></mark></td><td>Provision GPU-enabled virtual machines.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/4Z5HQEJhnkr1210U21lx">/spaces/7UCOMsy4OdTiBAQDMD27/pages/4Z5HQEJhnkr1210U21lx</a></td></tr><tr><td><mark style="color:blue;"><strong>VM Auto Scaling</strong></mark></td><td>Automatically scale virtual machines based on demand.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/CGs4v3YamvXRhaD7GEl6">/spaces/7UCOMsy4OdTiBAQDMD27/pages/CGs4v3YamvXRhaD7GEl6</a></td></tr></tbody></table>

#### Containers

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Managed Kubernetes</strong></mark></td><td>Deploy and manage Kubernetes clusters on IONOS Cloud.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/Kz4aEQsZpn3SkyZszpre">/spaces/7UCOMsy4OdTiBAQDMD27/pages/Kz4aEQsZpn3SkyZszpre</a></td></tr><tr><td><mark style="color:blue;"><strong>Private Container Registry</strong></mark></td><td>Manage Docker and OCI-compliant registries.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/NcienHJ91GXS35nX83Ya">/spaces/7UCOMsy4OdTiBAQDMD27/pages/NcienHJ91GXS35nX83Ya</a></td></tr></tbody></table>

#### Data Analytics

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Event Streams for Apache Kafka</strong></mark></td><td>Manage and interact with Kafka event streams.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/rW7p1o7r42UYAuirW7nh">/spaces/7UCOMsy4OdTiBAQDMD27/pages/rW7p1o7r42UYAuirW7nh</a></td></tr><tr><td><mark style="color:blue;"><strong>Managed Stackable Data Platform</strong></mark></td><td>Manage your Stackable Data Platform environment.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/xt5deCHzLZD0m8qmOKbj">/spaces/7UCOMsy4OdTiBAQDMD27/pages/xt5deCHzLZD0m8qmOKbj</a></td></tr></tbody></table>

#### Databases

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>In-Memory DB</strong></mark></td><td>Create and manage Redis® clusters.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/hFAnUG7HOg1t3nAR04R8">/spaces/7UCOMsy4OdTiBAQDMD27/pages/hFAnUG7HOg1t3nAR04R8</a></td></tr><tr><td><mark style="color:blue;"><strong>MariaDB</strong></mark></td><td>Create and manage MariaDB clusters.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/ZhxicGdVn33mJ2JoAgX3">/spaces/7UCOMsy4OdTiBAQDMD27/pages/ZhxicGdVn33mJ2JoAgX3</a></td></tr><tr><td><mark style="color:blue;"><strong>MongoDB V1</strong></mark></td><td>Manage MongoDB databases on the cloud with the v1 API.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/f0MUrPInfqKT0GSHd6Ws">/spaces/7UCOMsy4OdTiBAQDMD27/pages/f0MUrPInfqKT0GSHd6Ws</a></td></tr><tr><td><mark style="color:blue;"><strong>MongoDB V2</strong></mark></td><td>Manage MongoDB databases on the cloud with the v2 API.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/SBtN6nIGcjrGrrGIzCiO">/spaces/7UCOMsy4OdTiBAQDMD27/pages/SBtN6nIGcjrGrrGIzCiO</a></td></tr><tr><td><mark style="color:blue;"><strong>PostgreSQL V1</strong></mark></td><td>Create and manage PostgreSQL clusters with the v1 API.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/X8NPrksZARVedZTiVd9z">/spaces/7UCOMsy4OdTiBAQDMD27/pages/X8NPrksZARVedZTiVd9z</a></td></tr><tr><td><mark style="color:blue;"><strong>PostgreSQL V2</strong></mark></td><td>Create and manage PostgreSQL clusters with the v2 API.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/Ep7YhkuymiQuX3WE8fvo">/spaces/7UCOMsy4OdTiBAQDMD27/pages/Ep7YhkuymiQuX3WE8fvo</a></td></tr></tbody></table>

#### Network Services

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>API Gateway</strong></mark></td><td>Manage and configure API gateway instances.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/cyHdF62yS01qO7C4Vhen">/spaces/7UCOMsy4OdTiBAQDMD27/pages/cyHdF62yS01qO7C4Vhen</a></td></tr><tr><td><mark style="color:blue;"><strong>CDN</strong></mark></td><td>Manage and configure CDN distributions.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/AQRNBy7wkqV8bUT4n6Ko">/spaces/7UCOMsy4OdTiBAQDMD27/pages/AQRNBy7wkqV8bUT4n6Ko</a></td></tr><tr><td><mark style="color:blue;"><strong>Certificate Manager</strong></mark></td><td>Provision and manage TLS certificates.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/Jt1DgvkhNyGFlRaPJhXn">/spaces/7UCOMsy4OdTiBAQDMD27/pages/Jt1DgvkhNyGFlRaPJhXn</a></td></tr><tr><td><mark style="color:blue;"><strong>Cloud DNS</strong></mark></td><td>Manage DNS zones and records.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/1ERWzakeucEstNuuS6yD">/spaces/7UCOMsy4OdTiBAQDMD27/pages/1ERWzakeucEstNuuS6yD</a></td></tr><tr><td><mark style="color:blue;"><strong>Cross Connect</strong></mark></td><td>Manage physical cross-connects between networks.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/9lPQSZeqwXlDXuNNSDSX">/spaces/7UCOMsy4OdTiBAQDMD27/pages/9lPQSZeqwXlDXuNNSDSX</a></td></tr><tr><td><mark style="color:blue;"><strong>Flow Logs</strong></mark></td><td>Capture and analyze network flow logs.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/LyDcUsx9IBfrhkJI77u8">/spaces/7UCOMsy4OdTiBAQDMD27/pages/LyDcUsx9IBfrhkJI77u8</a></td></tr><tr><td><mark style="color:blue;"><strong>Managed Application Load Balancer</strong></mark></td><td>Configure and manage application load balancers.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/JH6lp44tR3WMcVGYK1j8">/spaces/7UCOMsy4OdTiBAQDMD27/pages/JH6lp44tR3WMcVGYK1j8</a></td></tr><tr><td><mark style="color:blue;"><strong>Managed NAT Gateway</strong></mark></td><td>Manage NAT gateways for private networks.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/cW6IgW6HWe5YiZ0Po1mA">/spaces/7UCOMsy4OdTiBAQDMD27/pages/cW6IgW6HWe5YiZ0Po1mA</a></td></tr><tr><td><mark style="color:blue;"><strong>Managed Network Load Balancer</strong></mark></td><td>Configure and manage network load balancers.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/q9PNEnImqDnMdl0Ottgq">/spaces/7UCOMsy4OdTiBAQDMD27/pages/q9PNEnImqDnMdl0Ottgq</a></td></tr><tr><td><mark style="color:blue;"><strong>Network Security Groups</strong></mark></td><td>Manage security groups for network traffic control.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/FkGCovi3CWjGg5jIA3KH">/spaces/7UCOMsy4OdTiBAQDMD27/pages/FkGCovi3CWjGg5jIA3KH</a></td></tr><tr><td><mark style="color:blue;"><strong>VPN Gateway</strong></mark></td><td>Manage and configure VPN gateways.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/EmhIK5pSuuvHLDS7KoUB">/spaces/7UCOMsy4OdTiBAQDMD27/pages/EmhIK5pSuuvHLDS7KoUB</a></td></tr></tbody></table>

#### Observability

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Activity Log</strong></mark></td><td>Audit user activities and resource changes.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/HTwxGuZ7QAxYIt4fqErh">/spaces/7UCOMsy4OdTiBAQDMD27/pages/HTwxGuZ7QAxYIt4fqErh</a></td></tr><tr><td><mark style="color:blue;"><strong>Logging Service</strong></mark></td><td>Observe, search, and filter logs.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/Wl3WLXhRYc6ufdLIzpfa">/spaces/7UCOMsy4OdTiBAQDMD27/pages/Wl3WLXhRYc6ufdLIzpfa</a></td></tr><tr><td><mark style="color:blue;"><strong>Monitoring Service</strong></mark></td><td>Ingest, aggregate, and analyze monitoring data.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/18F7RmJ4FonDrs6QXxb9">/spaces/7UCOMsy4OdTiBAQDMD27/pages/18F7RmJ4FonDrs6QXxb9</a></td></tr><tr><td><mark style="color:blue;"><strong>Monitoring as a Service (Legacy)</strong></mark></td><td>Legacy monitoring API.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/lIFFYsxsAQZREfaNVN7S">/spaces/7UCOMsy4OdTiBAQDMD27/pages/lIFFYsxsAQZREfaNVN7S</a></td></tr></tbody></table>

#### Storage & Backup

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Backup Service</strong></mark></td><td>Manage and configure backup services for your resources.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/eWEBQERKGSEUQqrHnacr">/spaces/7UCOMsy4OdTiBAQDMD27/pages/eWEBQERKGSEUQqrHnacr</a></td></tr><tr><td><mark style="color:blue;"><strong>IONOS Object Storage</strong></mark></td><td>Store, retrieve, and delete objects.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/w4hgSVlwsihCEtNEjLre">/spaces/7UCOMsy4OdTiBAQDMD27/pages/w4hgSVlwsihCEtNEjLre</a></td></tr><tr><td><mark style="color:blue;"><strong>IONOS Object Storage Management</strong></mark></td><td>Manage object storage resources.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/XKriwEpYnLCEUlhfwzdT">/spaces/7UCOMsy4OdTiBAQDMD27/pages/XKriwEpYnLCEUlhfwzdT</a></td></tr><tr><td><mark style="color:blue;"><strong>IONOS Object Storage (contract-owned buckets)</strong></mark></td><td>S3-compatible API for contract-owned buckets (HMAC).</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/PtgIx2FnzaigMJtawz3E">/spaces/7UCOMsy4OdTiBAQDMD27/pages/PtgIx2FnzaigMJtawz3E</a></td></tr><tr><td><mark style="color:blue;"><strong>IONOS Object Storage (user-owned buckets)</strong></mark></td><td>S3-compatible API for user-owned buckets (HMAC).</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/Vetn7Zp69nbpjM9WYDOL">/spaces/7UCOMsy4OdTiBAQDMD27/pages/Vetn7Zp69nbpjM9WYDOL</a></td></tr><tr><td><mark style="color:blue;"><strong>Network File Storage</strong></mark></td><td>Manage shared file storage via NFS.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/vRl3qf8zjpjvctldYSG5">/spaces/7UCOMsy4OdTiBAQDMD27/pages/vRl3qf8zjpjvctldYSG5</a></td></tr></tbody></table>

#### Security

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Auth</strong></mark></td><td>Generate access tokens for secure API access.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/TEzfX2w4I8ucO8oLXL3g">/spaces/7UCOMsy4OdTiBAQDMD27/pages/TEzfX2w4I8ucO8oLXL3g</a></td></tr><tr><td><mark style="color:blue;"><strong>Identity</strong></mark></td><td>Manage IAM resources and password policies.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/PgzcKmi5WfnXDJyO9TY5">/spaces/7UCOMsy4OdTiBAQDMD27/pages/PgzcKmi5WfnXDJyO9TY5</a></td></tr></tbody></table>

#### Billing & Management

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Billing</strong></mark></td><td>Retrieve resource usage and invoices.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/9PPeR34GRjfIN46hQsKA">/spaces/7UCOMsy4OdTiBAQDMD27/pages/9PPeR34GRjfIN46hQsKA</a></td></tr><tr><td><mark style="color:blue;"><strong>Reseller</strong></mark></td><td>Manage contracts and admin users.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/9rePE0uVjXJp5vQmSR7d">/spaces/7UCOMsy4OdTiBAQDMD27/pages/9rePE0uVjXJp5vQmSR7d</a></td></tr><tr><td><mark style="color:blue;"><strong>Quota</strong></mark></td><td>View and manage quotas for your contract.</td><td><a href="/spaces/7UCOMsy4OdTiBAQDMD27/pages/wiItkCZCWUP7h79ggF5r">/spaces/7UCOMsy4OdTiBAQDMD27/pages/wiItkCZCWUP7h79ggF5r</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ionos.com/api-reference/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.