API docs by Redocly

IONOS Cloud - Managed Stackable Data Platform API (1.1.0)

Download OpenAPI specification:Download

URL: https://www.ionos.com

Managed Stackable Data Platform by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform.

The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the Data Center Designer (DCD).

IONOS Cloud - API documentation

Getting Started

To get your DataPlatformCluster up and running, the following steps needs to be performed.

IONOS Cloud Account

The first step is the creation of a IONOS Cloud account if not already existing.

To register a new account, visit cloud.ionos.com.

Virtual Data Center (VDC)

The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so.

A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (ionosctl), or the DCD Web interface. For more information, see the official documentation.

Get a authentication token

To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way:

ionosctl token generate

For more information, see.

Create a new DataPlatformCluster

Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created.

To create a cluster, use the Create DataPlatformCluster API endpoint.

The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the Get Endpoint with the cluster ID that was presented to you in the response of the create cluster call.

Add a DataPlatformNodePool

To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case.

To create a new node pool use the Create DataPlatformNodepool endpoint.

Receive Kubeconfig

Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster.

To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the default namespace.

If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of hierarchical namespaces (HNS). You can find more details here.

The kubeconfig can be downloaded with the Get Kubeconfig endpoint using the cluster ID of the created DataPlatformCluster.

Create Stackable Services

You can leverage the kubeconfig.json file to access the Managed Stackable Data Platform cluster and manage the deployment of Stackable data apps.

With the Stackable operators, you can deploy the data apps you want in your Data Platform cluster.

Authorization

All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found here.

Basic Auth

The basic auth scheme uses the IONOS Cloud user credentials in form of a Basic Authentication header accordingly to RFC 7617.

API Key as Bearer Token

The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the documentation). For every request to be authenticated, the token is passed as Authorization Bearer header along with the request.

Permissions and Access Roles

Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege Manage Dataplatform can access the API.

Components

The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on.

DataPlatformCluster

A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build.

In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators.

DataPlatformNodePool

A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation.

Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API.

References

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

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:
tokenAuthbasicAuth
query Parameters
name
string <= 63 characters ^[-A-Za-z0-9_.]*$

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.

Responses

Response samples

Content type
application/json
{
  • "id": "dataplatform/clusters",
  • "type": "collection",
  • "href": "https://.../clusters",
  • "items": [
    ]
}

Create a DataPlatformCluster

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:
tokenAuthbasicAuth
Request Body schema: application/json

Request payload with the properties that defines a new DataPlatformCluster and the credentials to interact with the PaaS API to create it.

required
object (CreateClusterProperties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "cluster",
  • "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve a DataPlatformCluster

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:
tokenAuthbasicAuth
path Parameters
clusterId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

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

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "cluster",
  • "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e",
  • "metadata": {
    },
  • "properties": {
    }
}

Partially Modify a DataPlatformCluster

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:
tokenAuthbasicAuth
path Parameters
clusterId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

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

Request Body schema: application/json

Request payload with the properties that shall be applied to an existing DataPlatformCluster.

required
object (PatchClusterProperties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "cluster",
  • "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete a DataPlatformCluster

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:
tokenAuthbasicAuth
path Parameters
clusterId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

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

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "cluster",
  • "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e",
  • "metadata": {
    },
  • "properties": {
    }
}

Read the Kubeconfig

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:
tokenAuthbasicAuth
path Parameters
clusterId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

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

Responses

Response samples

Content type
application/json
{ }

DataPlatformNodePool

Node pools are the resources that powers the DataPlatformCluster.

The following requests allows to alter the existing resources, add or remove new resources to the cluster.

List the DataPlatformNodePools of a DataPlatformCluster

List all node pools assigned to the specified DataPlatformCluster by its 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:
tokenAuthbasicAuth
path Parameters
clusterId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

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

Responses

Response samples

Content type
application/json
{
  • "id": "dataplatform/clusters",
  • "type": "collection",
  • "href": "https://.../clusters/.../nodepools",
  • "items": [
    ]
}

Create a DataPlatformNodePool for a distinct DataPlatformCluster

Creates a new node pool and assigns the node pool resources exclusively to the defined managed cluster.

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

Authorizations:
tokenAuthbasicAuth
path Parameters
clusterId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

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

Request Body schema: application/json

Request payload with the properties that defines a DataPlatformNodePool.

required
object (CreateNodePoolProperties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "nodepool",
  • "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/nodepools/abcd7e2f-9876-1234-abcd-123459498ae7",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve a DataPlatformNodePool

Retrieve a node pool belonging to a Kubernetes cluster running Stackable by using its ID.

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

The node pool ID can be found in the response when a node pool is created or when you GET a list of all node pools assigned to a specific DataPlatformCluster.

Authorizations:
tokenAuthbasicAuth
path Parameters
clusterId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

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

nodepoolId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

The unique ID of the node pool. Must conform to the UUID format.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "nodepool",
  • "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/nodepools/abcd7e2f-9876-1234-abcd-123459498ae7",
  • "metadata": {
    },
  • "properties": {
    }
}

Partially Modify a DataPlatformNodePool

Modifies the specified node pool of a DataPlatformCluster. Update selected attributes of a node pool belonging to a Kubernetes cluster running Stackable.

The fields in the request body are applied to the cluster. Note that the application to the node pool itself is performed asynchronously. You can check the sync state by querying the node pool with the GET method.

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

The node pool ID can be found in the response when a node pool is created or when you GET a list of all node pools assigned to a specific DataPlatformCluster.

Authorizations:
tokenAuthbasicAuth
path Parameters
clusterId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

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

nodepoolId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

The unique ID of the node pool. Must conform to the UUID format.

Request Body schema: application/json

Request payload with the properties that shall be applied to an existing DataPlatformNodePool.

required
object (PatchNodePoolProperties)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "nodepool",
  • "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/nodepools/abcd7e2f-9876-1234-abcd-123459498ae7",
  • "metadata": {
    },
  • "properties": {
    }
}

Remove a DataPlatformNodePool from a DataPlatformCluster

Removes the specified node pool from the specified DataPlatformCluster and deletes the node pool afterwards.

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

The node pool ID can be found in the response when a node pool is created or when you GET a list of all node pools assigned to a specific DataPlatformCluster.

Authorizations:
tokenAuthbasicAuth
path Parameters
clusterId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

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

nodepoolId
required
string <uuid> [ 32 .. 36 ] characters ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a...

The unique ID of the node pool. Must conform to the UUID format.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "nodepool",
  • "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/nodepools/abcd7e2f-9876-1234-abcd-123459498ae7",
  • "metadata": {
    },
  • "properties": {
    }
}

DataPlatformMetaData

Metadata about the API such as supported versions.

Managed Stackable Data Platform API Versions

Retrieves all available versions of the Managed Stackable Data Platform.

Authorizations:
tokenAuthbasicAuth

Responses

Response samples

Content type
application/json
{
  • "id": "dataplatform/clusters",
  • "type": "collection",
  • "href": "https://.../versions",
  • "items": [
    ]
}