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

Clusters

A Kafka cluster that stores data and serve client requests. Kafka clusters typically have multiple brokers to handle more data and provide high availability. Each broker is identified by a unique ID and manages partitions of different topics.

This tag groups all operations for clusters.

Retrieve all Clusters

get

This endpoint enables retrieving all Clusters using pagination and optional filters.

Authorizations
Query parameters
filter.namestring · min: 2 · max: 63Optional

The name of your Kafka cluster. Must be 63 characters or less and must begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

Example: my-kafka-clusterPattern: ^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$
filter.statestringOptional

State of the resource. Resource states: AVAILABLE: There are no pending modification requests for this item. BUSY: There is at least one modification request pending and all following requests will be queued. DEPLOYING: The resource is being created. FAILED: The creation of the resource failed. UPDATING: The resource is being updated. FAILED_UPDATING: An update to the resource was not successful. DESTROYING: A delete command was issued, and the resource is being deleted.

Example: AVAILABLE
Responses
200
Returned all requested Clusters successfully.
application/json
Responseall of
get
GET /clusters HTTP/1.1
Host: kafka.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "ed17eb1f-ac43-5670-9e63-8be33c475449",
  "type": "collection",
  "href": "/clusters",
  "items": [
    {
      "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
      "type": "cluster",
      "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "state": "AVAILABLE",
        "message": "In progress.",
        "brokerAddresses": [
          "192.0.2.101:9093",
          "192.0.2.102:9093",
          "192.0.2.103:9093"
        ]
      },
      "properties": {
        "name": "my-kafka-cluster",
        "version": "3.9.0",
        "size": "XS",
        "connections": [
          {
            "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
            "lanId": "2",
            "brokerAddresses": [
              "192.0.2.101/24",
              "192.0.2.102/24",
              "192.0.2.103/24"
            ]
          }
        ]
      }
    }
  ]
}

Create Cluster

post

Creates a new Cluster.

The full Cluster needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations
Body
metadataanyOptional

Metadata

Responses
201
Cluster successfully created.
application/json
post
POST /clusters HTTP/1.1
Host: kafka.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "metadata": {},
  "properties": {
    "name": "my-kafka-cluster",
    "version": "3.9.0",
    "size": "XS",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "brokerAddresses": [
          "192.0.2.101/24",
          "192.0.2.102/24",
          "192.0.2.103/24"
        ]
      }
    ]
  }
}
{
  "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "type": "cluster",
  "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "In progress.",
    "brokerAddresses": [
      "192.0.2.101:9093",
      "192.0.2.102:9093",
      "192.0.2.103:9093"
    ]
  },
  "properties": {
    "name": "my-kafka-cluster",
    "version": "3.9.0",
    "size": "XS",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "brokerAddresses": [
          "192.0.2.101/24",
          "192.0.2.102/24",
          "192.0.2.103/24"
        ]
      }
    ]
  }
}

Retrieve Cluster

get

Returns the Cluster by ID.

Authorizations
Path parameters
clusterIdstring · uuidRequired

The ID (UUID) of the Cluster.

Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead
Responses
200
Getting Cluster was successful.
application/json
get
GET /clusters/{clusterId} HTTP/1.1
Host: kafka.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "type": "cluster",
  "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "In progress.",
    "brokerAddresses": [
      "192.0.2.101:9093",
      "192.0.2.102:9093",
      "192.0.2.103:9093"
    ]
  },
  "properties": {
    "name": "my-kafka-cluster",
    "version": "3.9.0",
    "size": "XS",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "brokerAddresses": [
          "192.0.2.101/24",
          "192.0.2.102/24",
          "192.0.2.103/24"
        ]
      }
    ]
  }
}

Delete Cluster

delete

Deletes the specified Cluster.

Authorizations
Path parameters
clusterIdstring · uuidRequired

The ID (UUID) of the Cluster.

Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead
Responses
202
Deleting Cluster was successful.
delete
DELETE /clusters/{clusterId} HTTP/1.1
Host: kafka.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

No content
PreviousEvent Streams for Apache KafkaNextTopics

Was this helpful?