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,
  "node_groups": [
    {
      "name": "<string>",
      "instance_type": "<string>",
      "desired_size": 123,
      "status": "<string>"
    }
  ],
  "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

Current active tier: large, xlarge, or unknown

kafka_memory
string
required
kafka_connect_memory
string
required
kafka_connect_replicas
integer
required
node_groups
NodeGroupStatus · object[]
required
active_operation_id
string | null

Operation ID if a scaling operation is in progress