Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
You can create a new Kafka cluster with specified configurations.
POST /clusters
The POST /clusters endpoint allows you to create a new Kafka cluster with specified properties. The name, version, size and connection fields are required. The response includes the ID, metadata, and properties of the newly created cluster, along with its current state and broker addresses.
Use this endpoint to provision a Kafka cluster tailored to your application's requirements, ensuring seamless integration and efficient data management.
metadata
No
object
Optional metadata for the cluster.
properties
Yes
object
Properties of the cluster to be created.
properties.name
Yes
string
The name of the Kafka cluster.
properties.version
Yes
string
The version of Kafka to use for the cluster.
properties.size
Yes
string
The size of the Kafka cluster.
properties.connections
No
array
List of connections for the cluster.
properties.connections[].datacenterId
Yes
string
The UUID of the data center where the cluster will be created.
properties.connections[].lanId
Yes
string
The LAN ID where the cluster will be connected.
properties.connections[].brokerAddresses
Yes
array
List of broker addresses for the cluster.
Allows you to create a new Kafka topic within a specified Kafka cluster.
POST /clusters/{clusterId}/topics
The POST /clusters/{clusterId}/topics endpoint creates a new Kafka topic within the specified Kafka cluster (clusterId). The request body must include the name of the topic, the other parameters are optional.
Upon successful creation, the endpoint returns detailed information about the newly created topic, including its ID (id), metadata, and properties. Use this endpoint to dynamically manage Kafka topics within your environment, ensuring efficient data distribution and retention policies.
Use this endpoint to dynamically manage Kafka topics within your environment, ensuring efficient data distribution and retention policies.
Allows you to deletes a Kafka cluster based on its ID.
DELETE /clusters/{clusterId}
The DELETE /clusters/{clusterId} endpoint initiates the deletion of a Kafka cluster identified by its unique UUID (clusterId). Upon successful deletion, the endpoint returns a 202 Accepted status code, indicating that the cluster deletion process has been initiated.
This action permanently removes the specified Kafka cluster and all associated resources. Use caution when invoking this endpoint as it cannot be undone.
Use this endpoint to manage and decommission Kafka clusters within your environment, ensuring efficient resource utilization and lifecycle management.
202 Accepted: The request to delete the cluster was successful.
clusterId
Yes
string
The UUID of the Kafka cluster where the topic will be created.
Example: /clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/topics
metadata
No
object
Optional metadata for the topic.
properties
Yes
object
Properties of the topic to be created.
properties.name
Yes
string
The name of the Kafka topic.
properties.replicationFactor
No
number
The number of replicas for the topic. This determines the fault tolerance.
properties.numberOfPartitions
No
number
The number of partitions for the topic. This affects the parallelism and throughput.
properties.logRetention
No
object
Configuration for log retention policies.
properties.logRetention.retentionTime
No
number
The retention time for logs in milliseconds. Defaults to 604800000 (7 days).
properties.logRetention.segmentBytes
No
number
The maximum size of a log segment in bytes before a new segment is rolled. Defaults to 1073741824 (1 GB).
clusterId
Yes
string
The UUID of the Kafka cluster to delete.
Example: /clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead
With this endpoint you can retrieve a list of Kafka clusters based on specified filters.
GET /clusters
The GET /clusters endpoint retrieves a collection of Kafka clusters based on specified filters. Use the filter.name parameter to search for clusters containing a specific name (case insensitive). Use the filter.state parameter to filter clusters based on their current state, such as AVAILABLE.
This endpoint provides essential information about each cluster, including its ID, metadata, properties, and connections. Use the returned data to manage and monitor Kafka clusters within your environment effectively.
filter.name
No
string
Only return Kafka clusters that contain the given name. This filter is case insensitive.
Example: filter.name=my-kafka-cluster
filter.state
No
string
Only return Kafka clusters with a given state.
Example: filter.state=AVAILABLE
Allows you to retrieve the details of a specific Kafka cluster based on its ID.
GET /clusters/{clusterId}
The GET /clusters/{clusterId} endpoint retrieves detailed information about a specific Kafka cluster identified by its unique UUID (clusterId). This endpoint returns metadata including creation and modification dates, ownership details, and current operational state. The properties section provides specific details such as the cluster name, version, size, and connection information including broker addresses and network configurations.
Use this endpoint to fetch comprehensive details about a Kafka cluster within your environment, facilitating effective management and monitoring of Kafka resources.
clusterId
Yes
string
The UUID of the Kafka cluster to retrieve.
Example: /clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead
With this endpoint you can retrieve details of a specific Kafka topic within a specified Kafka cluster.
GET /clusters/{clusterId}/topics/{topicId}
The GET /clusters/{clusterId}/topics/{topicId} endpoint retrieves detailed information about a specific Kafka topic identified by topicId within the Kafka cluster specified by clusterId. The response includes metadata such as creation and modification dates, ownership details, and current operational state. Additionally, topic properties such as name, replicationFactor, numberOfPartitions, and logRetention settings are provided.
Use this endpoint to fetch specific details of Kafka topics, facilitating effective monitoring and management of individual topics within your Kafka cluster.
clusterId
Yes
string
The UUID of the Kafka cluster where the topic belongs.
Example: /clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/topics/{topicId}
topicId
Yes
string
The UUID of the Kafka topic to retrieve details for.
Example: /clusters/{clusterId}/topics/ae085c4c-3626-5f1d-b4bc-cc53ae8267ce
Retrieves a specific user associated with a Kafka cluster, including access certificates in the metadata.
GET /clusters/{clusterId}/users/{userId}/access
The GET /clusters/{clusterId}/users/{userId}/access endpoint retrieves a specific user identified by userId from the Kafka cluster identified by clusterId. The response includes detailed metadata about the user, including creation and modification timestamps, ownership information, and current operational state. Access credentials such as certificateAuthority, privateKey, and certificate are also provided to facilitate secure communication with the Kafka cluster. Use this endpoint to manage and obtain detailed information about users' credentials within your Kafka infrastructure.
clusterId (string, path, required): The UUID of the Kafka cluster from which to retrieve the user.
Example: /clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/users/{userId}/access
userId (string, path, required): The UUID of the user whose credentials and metadata are to be retrieved.
Example: d11db12c-2625-5664-afd4-a3599731b5af
Learn to create a Kafka cluster.
Learn to verify the status of a Kafka cluster.
Learn to get a list of all your Kafka clusters.
Learn to delete a Kafka cluster.
Learn to create new topics in your cluster.
Get a list of all topics in the cluster.
Get detailed information about a specific topic.
Get a list of the users in the cluster.
Learn to fetch a list of users and their credentials.
Frankfurt, Germany: https://kafka.de-fra.ionos.com
Berlin, Germany: https://kafka.de-txl.ionos.com
This endpoint lets you fetch a list of all Kafka topics within a specified Kafka cluster.
GET /clusters/{clusterId}/topics
The GET /clusters/{clusterId}/topics endpoint retrieves a collection of all Kafka topics within the specified Kafka cluster identified by clusterId. Each topic includes detailed metadata such as creation and modification dates, ownership details, and current operational state. Topic properties like name, replicationFactor, numberOfPartitions, and logRetention settings are also provided.
Use this endpoint to fetch and monitor all Kafka topics within your environment, enabling efficient management and monitoring of data streams and event processing.
This endpoint allows you to retrieve all users associated with a specified Kafka cluster, supporting pagination and optional filters.
GET /clusters/{clusterId}/users
The GET /clusters/{clusterId}/users endpoint retrieves a collection of users associated with the Kafka cluster specified by clusterId. The response includes a paginated list of user objects, each containing metadata such as creation and modification details, ownership information, and current operational state. Use this endpoint to manage and monitor users within your Kafka cluster efficiently.
clusterId
Yes
string
The UUID of the Kafka cluster from which to retrieve topics.
Example: /clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/topics
clusterId
Yes
string
The UUID of the Kafka cluster from which to retrieve users.
Example: /clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/users