API docs by Redocly

Event Streams for Apache Kafka API (1.7.6)

Download OpenAPI specification:Download

IONOS Cloud Support: support@cloud.ionos.com URL: https://docs.ionos.com/support/general-information/contact-information

A managed Apache Kafka cluster is designed to be highly fault-tolerant and scalable, allowing large volumes of data to be ingested, stored, and processed in real-time. By distributing data across multiple brokers, Kafka achieves high throughput and low latency, making it suitable for applications requiring real-time data processing and analytics.

IONOS Cloud - API documentation

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

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

Authorizations:
tokenAuth
query Parameters
filter.name
string (KafkaClusterName) [ 2 .. 63 ] characters ^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$
Example: filter.name=my-kafka-cluster

Only return Kafka clusters that contain the given name. Case insensitive.

filter.state
string (State)
Example: filter.state=AVAILABLE

Only return Kafka clusters with a given state.

Responses

Response samples

Content type
application/json
{
  • "id": "ed17eb1f-ac43-5670-9e63-8be33c475449",
  • "type": "collection",
  • "href": "/clusters",
  • "items": [
    ]
}

Create Cluster

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

Cluster to create.

object

Metadata

required
object (Cluster)

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.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  • "type": "cluster",
  • "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Cluster

Returns the Cluster by ID.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the Cluster.

Responses

Response samples

Content type
application/json
{
  • "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  • "type": "cluster",
  • "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Cluster

Deletes the specified Cluster.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the Cluster.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Topics

A topic is a category or feed name to which records are published. Topics are the way Kafka organizes messages. They act as logical channels for data streams. Topics are split into partitions, making them scalable and allowing parallelism.

This tag groups all operations for topics.

Retrieve all Topics

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

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the cluster.

Responses

Response samples

Content type
application/json
{
  • "id": "7c1fe82d-a1ea-55fc-a744-12fad4180eef",
  • "type": "collection",
  • "href": "/clusters/{clusterId}/topics",
  • "items": [
    ]
}

Create Topic

Creates a new topic. The full topic needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the cluster.

Request Body schema: application/json

Topic to create.

object

Metadata

required
object (Topic)

A topic is a category or feed name to which records are published. Topics are the way Kafka organizes messages. They act as logical channels for data streams. Topics are split into partitions, making them scalable and allowing parallelism.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "ae085c4c-3626-5f1d-b4bc-cc53ae8267ce",
  • "type": "topic",
  • "href": "/clusters/{clusterId}/topics/ae085c4c-3626-5f1d-b4bc-cc53ae8267ce",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Topic

Returns the topic by ID.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the cluster.

topicId
required
string <uuid>
Example: ae085c4c-3626-5f1d-b4bc-cc53ae8267ce

The ID (UUID) of the topic.

Responses

Response samples

Content type
application/json
{
  • "id": "ae085c4c-3626-5f1d-b4bc-cc53ae8267ce",
  • "type": "topic",
  • "href": "/clusters/{clusterId}/topics/ae085c4c-3626-5f1d-b4bc-cc53ae8267ce",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Topic

Deletes the specified topic.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the cluster.

topicId
required
string <uuid>
Example: ae085c4c-3626-5f1d-b4bc-cc53ae8267ce

The ID (UUID) of the topic.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Users

The user of the cluster. Access is managed by certificates. The certificates are retrieved by the access endpoint.

This tag groups all operations for users.

Retrieve all Users

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

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the Cluster.

Responses

Response samples

Content type
application/json
{
  • "id": "434e0c83-031d-5f5a-be82-63ee54dda025",
  • "type": "collection",
  • "href": "/clusters/{clusterId}/users",
  • "items": [
    ]
}

Retrieve Apache Kafka User with Credentials

Returns the user by ID containing its access certificates in the metadata.

Authorizations:
tokenAuth
path Parameters
clusterId
required
string <uuid>
Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

The ID (UUID) of the cluster.

userId
required
string <uuid>
Example: d11db12c-2625-5664-afd4-a3599731b5af

The ID (UUID) of the user.

Responses

Response samples

Content type
application/json
{
  • "id": "d11db12c-2625-5664-afd4-a3599731b5af",
  • "type": "user",
  • "href": "/clusters/{clusterId}/users/d11db12c-2625-5664-afd4-a3599731b5af",
  • "metadata": {
    },
  • "properties": {
    }
}