1 of 1

List all Kafka clusters

With this endpoint you can retrieve a list of Kafka clusters based on specified filters.

Endpoint

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.

Parameters

Query Parameters

Required

Type

Description

filter.name

string

Only return Kafka clusters that contain the given name. This filter is case insensitive. Example: filter.name=my-kafka-cluster

filter.state

string

Only return Kafka clusters with a given state. Example: filter.state=AVAILABLE

Response

{
  "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.168.1.101:9093",
          "192.168.1.102:9093",
          "192.168.1.103:9093"
        ]
      },
      "properties": {
        "name": "my-kafka-cluster",
        "version": "3.7.0",
        "size": "S",
        "connections": [
          {
            "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
            "lanId": "2",
            "brokerAddresses": [
              "192.168.1.101/24",
              "192.168.1.102/24",
              "192.168.1.103/24"
            ]
          }
        ]
      }
    }
  ]
}

List all Kafka clusters

With this endpoint you can retrieve a list of Kafka clusters based on specified filters.

Endpoint

GET /clusters

Parameters

Query Parameters

Required

Type

Description

filter.name

string

Only return Kafka clusters that contain the given name. This filter is case insensitive. Example: filter.name=my-kafka-cluster

filter.state

string

Only return Kafka clusters with a given state. Example: filter.state=AVAILABLE

Response

{
  "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.168.1.101:9093",
          "192.168.1.102:9093",
          "192.168.1.103:9093"
        ]
      },
      "properties": {
        "name": "my-kafka-cluster",
        "version": "3.7.0",
        "size": "S",
        "connections": [
          {
            "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
            "lanId": "2",
            "brokerAddresses": [
              "192.168.1.101/24",
              "192.168.1.102/24",
              "192.168.1.103/24"
            ]
          }
        ]
      }
    }
  ]
}