Self Data Export

Self Data Export refers to the capability to export metadata from your IONOS Cloud infrastructure using API or specific tools.

Products for self data export

Metadata from the specific products listed below can be exported manually.

Product Categories	Products	Export Metadata using API
AI	AI Model Hub	Retrieve Data using AI Model Hub API
Compute Services	Virtual Servers (Dedicated Core Servers and vCPU Servers)	Retrieve metadata
Compute Services	Cubes	Retrieve metadata
Containers	Managed Kubernetes	Retrieve metadata
Containers	Private Container Registry	Retrieve metadata
Data Analytics	Event Streams for Apache Kafka	Retrieve metadata
Databases	In-Memory DB	Retrieve metadata
Databases	MariaDB	Retrieve metadata
Databases	MongoDB	Retrieve metadata
Databases	PostgreSQL	Retrieve metadata
Network Services	API Gateway	Retrieve metadata
Network Services	CDN with built-in WAF	Retrieve metadata
Network Services	Cloud DNS	Retrieve metadata
Network Services	Managed Application Load Balancer (ALB)	Retrieve metadata
Network Services	Managed NAT Gateway	Retrieve metadata
Network Services	Managed Network Load Balancer (NLB)	Retrieve metadata
Network Services	VM Autoscaling	Retrieve metadata
Network Services	VPN Gateway	Retrieve metadata
Observability	Activity Logs	Retrieve metadata
Observability	Logging Service	Retrieve metadata
Observability	Monitoring Service	Retrieve metadata
Storage & Backup	Block Storage	Retrieve metadata
Storage & Backup	Network File Storage	Retrieve metadata
Storage & Backup	IONOS Object Storage	Retrieve metadata
Security	Certificate Manager	Retrieve metadata

Services	Export option
VDC	Retrieve metadata
Identity & Access Management (IAM)	Retrieve metadata
IAM Password Policy Service	Retrieve metadata
IAM Token Manager	Retrieve metadata
Billing Service	Retrieve metadata
Reseller Service	Retrieve metadata
Acronis Backup	For more information, refer to the Acronis documentation

What information is included when exporting metadata via the API?

The platform provides metadata that includes various details such as the number of CPUs, allocated ram, nics, firewall settings, and specific product information. It also includes the UUID for each resource, its creation and modification history, and current status.

Additionally, the API response provides extra information whenever applicable. For example, when configuring Kubernetes node pools and performing a Get Kubernetes Clusters API request, the metadata specifies parameters such as the utilized Kubernetes version, total node count, and individual node configurations, compute resources, and network settings.

The following examples display the metadata retrieved using the Cloud API in its response:

Metadata retrieved using the Get Kubernetes Clusters API

Endpoint: https://api.ionos.com/cloudapi/v6/k8s Metadata:

{
  "id": "k8s",
  "type": "collection",
  "href": "https://api.ionos.com/cloudapi/v6/k8s",
  "items": [
    {
      "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
      "type": "k8s",
      "href": "https://api.ionos.com/cloudapi/v6/k8s/b0a6ed23-0636-4bd4-94aa-be01c355af1d",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "k8s",
        "k8sVersion": "1.15.4",
        "maintenanceWindow": {
          "dayOfTheWeek": "Monday",
          "time": "13:00:00"
        },
        "availableUpgradeVersions": [
          "1.16.4",
          "1.17.7"
        ],
        "viableNodePoolVersions": [
          "1.17.7",
          "1.18.2"
        ],
        "public": true,
        "location": "de/fra",
        "natGatewayIp": "198.51.100.100",
        "nodeSubnet": "192.168.0.0/16",
        "apiSubnetAllowList": [
          "1.2.3.4/32",
          "2002::1234:abcd:ffff:c0a8:101/64",
          "1.2.3.4",
          "2002::1234:abcd:ffff:c0a8:101"
        ],
        "s3Buckets": [
          {
            "name": "My Bucket"
          }
        ]
      },
      "entities": {
        "nodepools": {
          "id": "1e072e52-2ed3-492f-b6b6-c6b116907527/nodepools",
          "type": "collection",
          "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools",
          "items": [
            {
              "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
              "type": "nodepool",
              "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038",
              "metadata": {
                "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
                "createdDate": "2015-12-04T14:34:09.809Z",
                "createdBy": "[email protected]",
                "createdByUserId": "[email protected]",
                "lastModifiedDate": "2015-12-04T14:34:09.809Z",
                "lastModifiedBy": "[email protected]",
                "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
                "state": "AVAILABLE"
              },
              "properties": {
                "name": "K8s-node-pool",
                "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
                "nodeCount": 2,
                "serverType": "DedicatedCore",
                "cpuFamily": "INTEL_ICELAKE",
                "coresCount": 4,
                "ramSize": 2048,
                "availabilityZone": "AUTO",
                "storageType": "HDD",
                "storageSize": 100,
                "k8sVersion": "1.15.4",
                "maintenanceWindow": {
                  "dayOfTheWeek": "Monday",
                  "time": "13:00:00"
                },
                "autoScaling": {
                  "minNodeCount": 1,
                  "maxNodeCount": 3
                },
                "lans": [
                  {
                    "routes": []
                  }
                ],
                "labels": {
                  "property1": "string",
                  "property2": "string"
                },
                "annotations": {
                  "property1": "string",
                  "property2": "string"
                },
                "publicIps": [
                  "81.173.1.2",
                  "82.231.2.5",
                  "92.221.2.4"
                ],
                "availableUpgradeVersions": [
                  "1.16.4",
                  "1.17.7"
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

Metadata retrieved using the PostgreSQL List Clusters API

Endpoint: https://api.ionos.com/databases/postgresql/clusters Metadata:

{
    "type": "cluster",
    "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
    "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "[email protected]",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "state": "AVAILABLE"
    },
    "properties": {
        "displayName": "PostgreSQL cluster",
        "postgresVersion": "13",
        "location": "de/fra",
        "dnsName": "pg.example.com",
        "backupLocation": "de",
        "instances": 2,
        "ram": 2048,
        "cores": 4,
        "storageSize": 15000,
        "storageType": "HDD",
        "connections": [
            {
                "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
                "lanId": "2",
                "cidr": "192.168.1.100/24"
            }
        ],
        "maintenanceWindow": {
            "time": "16:30:59",
            "dayOfTheWeek": "Monday"
        },
        "synchronizationMode": "ASYNCHRONOUS",
        "connectionPooler": {
            "enabled": true,
            "poolMode": "transaction"
        }
    }
}

Metadata retrieved using the Block Storage Get Attached Volumes API

Endpoint: https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/servers/{serverId}/volumes Metadata:

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "<RESOURCE-URI>",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "volume",
      "href": "<RESOURCE-URI>",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "My resource",
        "type": "HDD",
        "size": 100,
        "availabilityZone": "AUTO",
        "image": "d6ad1576-fde9-4696-aa41-1ebd75bdaf49",
        "imagePassword": "mypass123",
        "imageAlias": "string",
        "sshKeys": [
          "ssh-rsa AAAAB3NzaC1yc2EA",
          "ssh-rsa AAAAB3NzaC1yc2EAAAA"
        ],
        "bus": "VIRTIO",
        "licenceType": "LINUX",
        "applicationType": "MSSQL-2019-Standard",
        "cpuHotPlug": true,
        "ramHotPlug": true,
        "nicHotPlug": true,
        "nicHotUnplug": true,
        "discVirtioHotPlug": true,
        "discVirtioHotUnplug": true,
        "exposeSerial": true,
        "requireLegacyBios": true,
        "deviceNumber": 3,
        "pciSlot": 7,
        "backupunitId": "25f67991-0f51-4efc-a8ad-ef1f1a481c",
        "userData": "string",
        "bootServer": "25f67991-0f51-4efc-a8ad-ef1fb1a481c",
        "bootOrder": "AUTO"
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "<PREVIOUS-PAGE-URI>",
    "self": "<THIS-PAGE-URI>",
    "next": "<NEXT-PAGE-URI>"
  }
}