Skip to main content
GET
/
cluster
/
status
Get Cluster Status
curl --request GET \
  --url https://api.streamkap.com/cluster/status \
  --header 'Authorization: Bearer <token>'
{
  "current_tier": "<string>",
  "kafka_memory": "<string>",
  "kafka_connect_memory": "<string>",
  "kafka_connect_replicas": 123,
  "kafka_connect_statefulsets": [
    {
      "name": "<string>",
      "memory": "<string>",
      "replicas": 123
    }
  ],
  "tiers": [
    {
      "name": "<string>",
      "order": 123,
      "kafka_memory": "<string>",
      "kafka_connect_memory": "<string>",
      "kafka_connect_replicas": 123,
      "node_groups": [
        {
          "role": "<string>",
          "name": "<string>",
          "nodes": 123,
          "az": "<string>",
          "instance_type": "<string>",
          "vcpu_per_node": 123,
          "memory_gib_per_node": 123,
          "ebs_volumes": [
            {
              "volume_type": "<string>",
              "size_gb": 123,
              "iops": 123,
              "throughput_mbps": 123,
              "volumes_per_node": 1
            }
          ]
        }
      ]
    }
  ],
  "active_operation_id": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

current_tier
string
required

Currently active tier name (matched from K8s StatefulSet specs).

kafka_memory
string
required
kafka_connect_memory
string
required
kafka_connect_replicas
integer
required
kafka_connect_statefulsets
KafkaConnectStatefulSetStatus · object[]

Per-StatefulSet live specs. One entry for single-KC tenants; multiple for KC-0 + KC-1 + ... tenants.

tiers
TierSpec · object[]

Every tier defined in the cluster_config, ordered ascending by 'order'.

active_operation_id
string | null

Operation ID if a scaling operation is in progress