IONOS API

openapi: 3.1.0
info:
  title: IONOS API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 7 operation(s) read from 17 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; IONOS has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 5
    pages-with-code: 4
    pages-read: 17
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://api.ionos.com/docs/cloud/v6
  - https://docs.ionos.com/cloud/databases/mariadb/api/v1-api.md
  - https://docs.ionos.com/cloud/databases/mongodb/api/v1-api.md
  - https://docs.ionos.com/cloud/databases/postgresql/api/v1-api.md
  - https://docs.ionos.com/cloud/databases/in-memory-db/api/v1-api.md
  - https://docs.ionos.com/cloud/databases/mongodb/api/v1-api/migration.md
  - https://docs.ionos.com/cloud/databases/postgresql/api/v1-api/metrics.md
  - https://docs.ionos.com/cloud/databases/postgresql/how-tos/v1/metrics.md
  - https://docs.ionos.com/cloud/databases/mongodb/api/v1-api/access-logs.md
  - https://docs.ionos.com/cloud/api-reference/databases/v2/authentication.md
  - https://docs.ionos.com/cloud/databases/postgresql/api/v1-api/migration.md
  - https://docs.ionos.com/cloud/databases/mariadb/api/v1-api/prerequisites.md
  - https://docs.ionos.com/cloud/databases/postgresql/api/v1-api/access-logs.md
  - https://docs.ionos.com/cloud/databases/mongodb/api/v1-api/users-management.md
  - https://docs.ionos.com/cloud/databases/postgresql/how-tos/v1/clone-cluster.md
  - https://docs.ionos.com/cloud/databases/postgresql/how-tos/v1/delete-cluster.md
  - https://docs.ionos.com/cloud/databases/postgresql/how-tos/v1/update-cluster.md
servers:
- url: https://dcd.ionos.com
paths:
  /cloud/databases/mariadb/api/v1-api/prerequisites.md:
    get:
      operationId: get_cloud_databases_mariadb_api_v1_api_prerequisites_md
      tags:
      - Cloud
      summary: Prerequisites
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.ionos.com/cloud/databases/mariadb/api/v1-api/prerequisites.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /cloud/databases/postgresql/api/v1-api/{v1apiid}:
    get:
      operationId: get_cloud_databases_postgresql_api_v1_api_v1apiid
      tags:
      - Cloud
      summary: Access Logs
      description: Fetch logs for a PostgreSQL cluster with optional filtering parameters.
      x-source: https://docs.ionos.com/cloud/databases/postgresql/api/v1-api/access-logs.md
      parameters:
      - name: v1apiid
        in: path
        required: true
        schema:
          type: string
      - name: start
        in: query
        required: false
        schema:
          type: string
        description: 'Retrieve log lines after this timestamp (format: RCF3339). Default: 30 days ago. Allowed: Between 30 days ago and now (before
          end).'
      - name: end
        in: query
        required: false
        schema:
          type: string
        description: 'Retrieve log line before this timestamp (format: RFC3339). Default: now. Allowed: Between 30 days ago and now (after start).'
      - name: direction
        in: query
        required: false
        schema:
          type: string
        description: 'Direction in which the logs are sorted and limited. Default: BACKWARD. Allowed values: BACKWARD, FORWARD.'
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: 'Maximum number of log lines to retrieve. Default: 100. Allowed: Between 1 and 5000.'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCloudDatabasesPostgresqlApiV1ApiV1ApiidResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at v1apiId
  /cloud/databases/postgresql/how-tos/v1/{v1id}:
    get:
      operationId: get_cloud_databases_postgresql_how_tos_v1_v1id
      tags:
      - Cloud
      summary: Clone a PostgreSQL Cluster
      x-source: https://docs.ionos.com/cloud/databases/postgresql/how-tos/v1/clone-cluster.md
      parameters:
      - name: v1id
        in: path
        required: true
        schema:
          type: string
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question to ask the documentation.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The broader goal behind the question.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 3 example path(s) differing only at v1Id
  /cloud/databases/{databaseid}/api/v1-api/migration.md:
    get:
      operationId: get_cloud_databases_databaseid_api_v1_api_migration_md
      tags:
      - Cloud
      summary: Database Migration
      description: Perform an HTTP GET request on the migration documentation page with the `ask` and `goal` query parameters to retrieve a direct
        answer and relevant excerpts.
      x-source: https://docs.ionos.com/cloud/databases/mongodb/api/v1-api/migration.md
      parameters:
      - name: databaseid
        in: path
        required: true
        schema:
          type: string
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at databaseId
  /databases/postgresql/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/logs:
    get:
      operationId: get_databases_postgresql_clusters_498ae72f_411f_11eb_9d07_046c59cc737e_logs
      tags:
      - Databases
      summary: GET /databases/postgresql/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/logs
      x-source: https://docs.ionos.com/cloud/databases/postgresql/api/v1-api/access-logs.md
      parameters:
      - name: direction
        in: query
        required: false
        schema:
          type: string
      - name: end
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: string
      - name: start
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --include  --request GET  --user "clientname@ionos.com:Mb2.r5oHf-0t"  --header "Content-Type: application/json"  https://api.ionos.com/databases/postgresql/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/logs?start=2022-01-05T12:00:00Z&end=2022-01-05T13:00:00Z&direction=FORWARD&limit=2

          ```'
  /datacenters:
    get:
      operationId: get_datacenters
      tags:
      - Datacenters
      summary: List your data centers
      description: List the data centers for your account. Default limit is the first 100 items; use pagination query parameters for listing more
        items.
      x-source: https://api.ionos.com/docs/cloud/v6
      parameters:
      - name: pretty
        in: query
        required: false
        schema:
          type: boolean
        description: Controls whether the response is pretty-printed (with indentations and new lines).
      - name: depth
        in: query
        required: false
        schema:
          type: integer
        description: Controls the detail depth of the response objects.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
        description: The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: The maximum number of elements to return (use together with offset for pagination).
      - name: X-Contract-Number
        in: header
        required: false
        schema:
          type: integer
        description: Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDatacentersResponse'
      x-evidence:
        kind: documentation
  /telemetry/api/v1/query_range:
    get:
      operationId: get_telemetry_api_v1_query_range
      tags:
      - Telemetry
      summary: GET /telemetry/api/v1/query_range
      x-source: https://docs.ionos.com/cloud/databases/postgresql/api/v1-api/metrics.md
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTelemetryApiV1QueryRangeResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --get https://dcd.ionos.com/telemetry/api/v1/query_range  --data-urlencode "query=ionos_dbaas_postgres_memory_available_bytes{postgres_cluster=\"498ae72f-411f-11eb-9d07-046c59cc737e\"}"  --data-urlencode
          "start=2022-12-06T12:32:37.076Z"  --data-urlencode "end=2022-12-06T12:47:37.076Z"  --data-urlencode "step=60"  --header ''Authorization:
          Bearer your_JWT_token''

          ```'
components:
  schemas:
    GetCloudDatabasesPostgresqlApiV1ApiV1ApiidResponse:
      type: object
      properties:
        instances:
          type: array
          description: List of instances with their log messages.
        instances[].name:
          type: string
          description: Instance identifier.
        instances[].messages:
          type: array
          description: Log messages for the instance.
        instances[].messages[].time:
          type: string
          description: Timestamp of the log entry.
        instances[].messages[].message:
          type: string
          description: Log message content.
    GetDatacentersResponse:
      type: object
      properties:
        '200':
          type: string
          description: Successful operation
        default:
          type: string
          description: 'Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404
            (not found), 405 (unsupported HTTP method), 415 (unsupported content type), 422 (validation error), 429 (request rate limit exceeded),
            500 (server error), or 503 (maintenance).'
    GetTelemetryApiV1QueryRangeResponse:
      type: object
      properties:
        resultType:
          type: string
        result:
          type: array
          items:
            type: object
            properties:
              metric:
                type: object
                properties:
                  __name__:
                    type: string
                  cloud_service:
                    type: string
                  contract_number:
                    type: string
                  instance:
                    type: string
                  postgres_cluster:
                    type: string
                  role:
                    type: string
              values:
                type: array
                items:
                  type: array
                  items:
                    type: number
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Cloud
- name: Databases
- name: Datacenters
- name: Telemetry