Get Cluster Status

Get current cluster status by fetching live state from EKS + K8s.

Reads tier definitions from the cluster_configs collection, then queries the actual cluster to determine current tier, memory, and replicas. BYOC services without a cluster_configs record get a live-only view (no tier catalog, scaling_available: false) that degrades to ‘unknown’ values instead of failing.

GET/cluster/status

Authorization

AuthorizationBearer token · headerrequired

Responses

200

Successful Response

current_tierstringrequired

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

kafka_memorystringrequired

kafka_connect_memorystringrequired

kafka_connect_replicasintegerrequired

kafka_connect_statefulsetsKafkaConnectStatefulSetStatus[]

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

Show properties

Array of KafkaConnectStatefulSetStatus

namestringrequired

memorystringrequired

replicasintegerrequired

tiersTierSpec[]

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

Show properties

Array of TierSpec

namestringrequired

orderintegerrequired

kafka_memorystringrequired

kafka_connect_memorystringrequired

kafka_connect_replicasintegerrequired

node_groupsTierNodeGroup[]

Kafka NG (one) plus all KC NGs across AZs.

Show properties

Array of TierNodeGroup

rolestringrequired

'kafka' or 'kafka_connect'

namestringrequired

EKS node group name

azstring | any

Show properties

Any of:

string

string

any

any

instance_typestring | any

Show properties

Any of:

string

string

any

any

vcpu_per_nodeinteger | any

Show properties

Any of:

integer

integer

any

any

memory_gib_per_nodeinteger | any

Show properties

Any of:

integer

integer

any

any

nodesintegerrequired

Desired node count for this NG on this tier

statusstring | any

Live EKS node group status (e.g. ACTIVE). Only set on live reads.

Show properties

Any of:

string

string

any

any

ebs_volumesEbsVolumeStatus[]

EBS volumes attached per node. Populated for the Kafka NG only; KC is stateless.

Show properties

Array of EbsVolumeStatus

volume_typestringrequired

size_gbintegerrequired

iopsintegerrequired

throughput_mbpsinteger | any

Show properties

Any of:

integer

integer

any

any

volumes_per_nodeinteger

default: 1

active_operation_idstring | any

Operation ID if a scaling operation is in progress

Show properties

Any of:

string

string

any

any

scaling_availableboolean

Whether scale operations are possible (a cluster_configs record exists). False for BYOC services rendered from live K8s state only.

default: true

live_node_groupsTierNodeGroup[]

Node groups read live from EKS/EC2 (with EBS volumes attached to the Kafka NG). Populated only on the config-less path, where no tier catalog exists.

Show properties

Array of TierNodeGroup

rolestringrequired

'kafka' or 'kafka_connect'

namestringrequired

EKS node group name

azstring | any

Show properties

Any of:

string

string

any

any

instance_typestring | any

Show properties

Any of:

string

string

any

any

vcpu_per_nodeinteger | any

Show properties

Any of:

integer

integer

any

any

memory_gib_per_nodeinteger | any

Show properties

Any of:

integer

integer

any

any

nodesintegerrequired

Desired node count for this NG on this tier

statusstring | any

Live EKS node group status (e.g. ACTIVE). Only set on live reads.

Show properties

Any of:

string

string

any

any

ebs_volumesEbsVolumeStatus[]

EBS volumes attached per node. Populated for the Kafka NG only; KC is stateless.

Show properties

Array of EbsVolumeStatus

volume_typestringrequired

size_gbintegerrequired

iopsintegerrequired

throughput_mbpsinteger | any

Show properties

Any of:

integer

integer

any

any

volumes_per_nodeinteger

default: 1

Request

curl -X GET "https://api.streamkap.com/cluster/status" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.streamkap.com/cluster/status", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.streamkap.com/cluster/status",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "current_tier": "string",
  "kafka_memory": "string",
  "kafka_connect_memory": "string",
  "kafka_connect_replicas": 0,
  "kafka_connect_statefulsets": [
    {
      "name": "string",
      "memory": "string",
      "replicas": 0
    }
  ],
  "tiers": [
    {
      "name": "string",
      "order": 0,
      "kafka_memory": "string",
      "kafka_connect_memory": "string",
      "kafka_connect_replicas": 0,
      "node_groups": [
        {
          "role": "string",
          "name": "string",
          "az": "string",
          "instance_type": "string",
          "vcpu_per_node": 0,
          "memory_gib_per_node": 0,
          "nodes": 0,
          "status": "string",
          "ebs_volumes": [
            {
              "volume_type": "string",
              "size_gb": 0,
              "iops": 0,
              "throughput_mbps": 0,
              "volumes_per_node": 1
            }
          ]
        }
      ]
    }
  ],
  "active_operation_id": "string",
  "scaling_available": true,
  "live_node_groups": [
    {
      "role": "string",
      "name": "string",
      "az": "string",
      "instance_type": "string",
      "vcpu_per_node": 0,
      "memory_gib_per_node": 0,
      "nodes": 0,
      "status": "string",
      "ebs_volumes": [
        {
          "volume_type": "string",
          "size_gb": 0,
          "iops": 0,
          "throughput_mbps": 0,
          "volumes_per_node": 1
        }
      ]
    }
  ]
}