AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

DataPlatformCluster

IONOS Cloud allows to quickly deploy a DataPlatformCluster that runs the needed Stackable operators to build a Managed Stackable Data Platform or a tailored business intelligence solution.

The following request allows to interact with the already created clusters or creates new clusters with in your virtual data center.

List the DataPlatformClusters

get

List all available DataPlatformClusters that can be accessed by the user.

The user might filter the request for the name of the DataPlatformCluster. If no cluster is available matching the request, the list will be empty.

Authorizations
Query parameters
namestring · max: 63Optional

Response filter to list only the clusters which include the specified name. The value is case insensitive and matched on the name property of the cluster. The input is limited to 63 characters with alphanumeric characters ([a-z0-9A-Z]), dashes (-), underscores (_), and dots (.) allowed.

Pattern: ^[-A-Za-z0-9_.]*$
Responses
200
List of DataPlatformClusters the user can access and that fits the filter if the filter parameter was used.
application/json
get
GET /dataplatform/clusters HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "dataplatform/clusters",
  "type": "collection",
  "href": "https://.../clusters",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "cluster",
      "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e",
      "metadata": {
        "ETag": "123aaa5d587dcd0d58f767d464abcdef",
        "createdDate": "2020-12-10T13:37:50Z",
        "createdBy": "[email protected]",
        "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
        "createdInContractNumber": "12315812",
        "lastModifiedDate": "2020-12-11T13:37:50Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
        "currentDataPlatformVersion": "22.11",
        "currentDataPlatformRevision": 2,
        "availableUpgradeVersions": [
          "22.11"
        ],
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "my-cluster",
        "dataPlatformVersion": "22.11",
        "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
        "maintenanceWindow": {
          "time": "16:30:59",
          "dayOfTheWeek": "Monday"
        },
        "lans": [
          {
            "lanId": "ionoscloud_lan.example.id",
            "dhcp": true,
            "routes": [
              {
                "network": "192.168.0.1/24",
                "gateway": "192.168.0.1"
              }
            ]
          }
        ]
      }
    }
  ]
}

Create a DataPlatformCluster

post

Creates a new DataPlatformCluster.

The cluster will be provisioned in the data center matching the provided DatacenterId. Therefore the data center must be created upfront and must be editable by the user issuing the request.

To create a new virtual data center (VDC), see.

Authorizations
Body

Data to create a new DataPlatformCluster.

Responses
200
The DataPlatformCluster as stored after the create or update operation was applied or the DataPlatformCluster properties before the delete operation was performed.
application/json
post
POST /dataplatform/clusters HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 307

{
  "properties": {
    "name": "my-cluster",
    "dataPlatformVersion": "22.11",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "lans": [
      {
        "lanId": "ionoscloud_lan.example.id",
        "dhcp": true,
        "routes": [
          {
            "network": "192.168.0.1/24",
            "gateway": "192.168.0.1"
          }
        ]
      }
    ]
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "cluster",
  "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {
    "ETag": "123aaa5d587dcd0d58f767d464abcdef",
    "createdDate": "2020-12-10T13:37:50Z",
    "createdBy": "[email protected]",
    "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
    "createdInContractNumber": "12315812",
    "lastModifiedDate": "2020-12-11T13:37:50Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
    "currentDataPlatformVersion": "22.11",
    "currentDataPlatformRevision": 2,
    "availableUpgradeVersions": [
      "22.11"
    ],
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "my-cluster",
    "dataPlatformVersion": "22.11",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "lans": [
      {
        "lanId": "ionoscloud_lan.example.id",
        "dhcp": true,
        "routes": [
          {
            "network": "192.168.0.1/24",
            "gateway": "192.168.0.1"
          }
        ]
      }
    ]
  }
}

Retrieve a DataPlatformCluster

get

Retrieve the specified DataPlatformCluster by its distinct ID.

The cluster ID can be found in the response when a cluster is created or when you GET a list of all DataPlatformClusters.

Authorizations
Path parameters
clusterIdstring · uuid · min: 32 · max: 36Required

The unique ID of the cluster. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
Responses
200
The DataPlatformCluster as stored after the create or update operation was applied or the DataPlatformCluster properties before the delete operation was performed.
application/json
get
GET /dataplatform/clusters/{clusterId} HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "cluster",
  "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {
    "ETag": "123aaa5d587dcd0d58f767d464abcdef",
    "createdDate": "2020-12-10T13:37:50Z",
    "createdBy": "[email protected]",
    "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
    "createdInContractNumber": "12315812",
    "lastModifiedDate": "2020-12-11T13:37:50Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
    "currentDataPlatformVersion": "22.11",
    "currentDataPlatformRevision": 2,
    "availableUpgradeVersions": [
      "22.11"
    ],
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "my-cluster",
    "dataPlatformVersion": "22.11",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "lans": [
      {
        "lanId": "ionoscloud_lan.example.id",
        "dhcp": true,
        "routes": [
          {
            "network": "192.168.0.1/24",
            "gateway": "192.168.0.1"
          }
        ]
      }
    ]
  }
}

Delete a DataPlatformCluster

delete

Deletes the specified DataPlatformCluster by its distinct cluster ID.

The ID can be found in the response when a cluster is created or when you GET a list of all DataPlatformClusters.

Authorizations
Path parameters
clusterIdstring · uuid · min: 32 · max: 36Required

The unique ID of the cluster. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
Responses
200
The DataPlatformCluster as stored after the create or update operation was applied or the DataPlatformCluster properties before the delete operation was performed.
application/json
delete
DELETE /dataplatform/clusters/{clusterId} HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "cluster",
  "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {
    "ETag": "123aaa5d587dcd0d58f767d464abcdef",
    "createdDate": "2020-12-10T13:37:50Z",
    "createdBy": "[email protected]",
    "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
    "createdInContractNumber": "12315812",
    "lastModifiedDate": "2020-12-11T13:37:50Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
    "currentDataPlatformVersion": "22.11",
    "currentDataPlatformRevision": 2,
    "availableUpgradeVersions": [
      "22.11"
    ],
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "my-cluster",
    "dataPlatformVersion": "22.11",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "lans": [
      {
        "lanId": "ionoscloud_lan.example.id",
        "dhcp": true,
        "routes": [
          {
            "network": "192.168.0.1/24",
            "gateway": "192.168.0.1"
          }
        ]
      }
    ]
  }
}

Partially Modify a DataPlatformCluster

patch

Modifies the specified DataPlatformCluster by its distinct cluster ID. The fields in the request body are applied to the cluster. Note that the application to the cluster itself is performed asynchronously. You can check the sync state by querying the cluster with the GET method.

The ID can be found in the response when a cluster is created or when you GET a list of all DataPlatformClusters.

Authorizations
Path parameters
clusterIdstring · uuid · min: 32 · max: 36Required

The unique ID of the cluster. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
Body

Data to update selected properties of a DataPlatformCluster.

Responses
200
The DataPlatformCluster as stored after the create or update operation was applied or the DataPlatformCluster properties before the delete operation was performed.
application/json
patch
PATCH /dataplatform/clusters/{clusterId} HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "properties": {
    "name": "my-cluster",
    "dataPlatformVersion": "22.11",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "lans": [
      {
        "lanId": "ionoscloud_lan.example.id",
        "dhcp": true,
        "routes": [
          {
            "network": "192.168.0.1/24",
            "gateway": "192.168.0.1"
          }
        ]
      }
    ]
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "cluster",
  "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {
    "ETag": "123aaa5d587dcd0d58f767d464abcdef",
    "createdDate": "2020-12-10T13:37:50Z",
    "createdBy": "[email protected]",
    "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
    "createdInContractNumber": "12315812",
    "lastModifiedDate": "2020-12-11T13:37:50Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
    "currentDataPlatformVersion": "22.11",
    "currentDataPlatformRevision": 2,
    "availableUpgradeVersions": [
      "22.11"
    ],
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "my-cluster",
    "dataPlatformVersion": "22.11",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "lans": [
      {
        "lanId": "ionoscloud_lan.example.id",
        "dhcp": true,
        "routes": [
          {
            "network": "192.168.0.1/24",
            "gateway": "192.168.0.1"
          }
        ]
      }
    ]
  }
}

Read the Kubeconfig

get

Retrieves the Kubernetes configuration file (kubeconfig) for the specified DataPlatformCluster by its cluster ID.

The ID can be found in the response when a cluster is created or when you GET a list of all DataPlatformClusters.

Authorizations
Path parameters
clusterIdstring · uuid · min: 32 · max: 36Required

The unique ID of the cluster. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
Responses
200
Successful operation.
application/json
Responseobject
get
GET /dataplatform/clusters/{clusterId}/kubeconfig HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Accept: */*

{}
PreviousReferencesNextDataPlatformNodePool

Was this helpful?