> ## Documentation Index
> Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi/openapi.json get /cluster/status
openapi: 3.1.0
info:
  title: Streamkap REST API
  description: >-
    The Streamkap REST API allows you to programmatically manage your CDC
    pipelines, sources, destinations, transforms, and more.


    Authenticate using a bearer token obtained from the [Access
    Token](/api-reference/auth/access-token) endpoint with your API client
    credentials.
  contact:
    name: Streamkap Support
    url: https://streamkap.com/
    email: support@streamkap.com
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.streamkap.com
    description: Production
security: []
tags:
  - name: Alerts
    description: Manage alert subscribers, preferences, and notification credentials.
  - name: Authentication
    description: Obtain and refresh access tokens, manage client credentials and roles.
  - name: Billing
    description: Retrieve usage metrics, summaries, and export billing data.
  - name: Consumer Groups
    description: List, inspect, and reset Kafka consumer group offsets.
  - name: Dashboard
    description: Retrieve organisation-level statistics and overview data.
  - name: Destinations
    description: Create, configure, and manage data destinations and their lifecycle.
  - name: Kafka Access
    description: Manage Kafka users and their access permissions.
  - name: Logs
    description: Query and summarise system logs.
  - name: Pipelines
    description: Create, configure, and manage CDC pipelines and their lifecycle.
  - name: Project Keys
    description: Manage project keys that bundle API credentials and optional Kafka access.
  - name: Schema Registry
    description: Browse schema subjects, versions, and retrieve schema definitions.
  - name: Services
    description: View and switch service metadata.
  - name: Sources
    description: >-
      Create, configure, and manage data sources, snapshots, and their
      lifecycle.
  - name: Tags
    description: Create, update, and manage resource tags for organisation.
  - name: Topics
    description: Browse topic details, statistics, configurations, metrics, and messages.
  - name: Transforms
    description: >-
      Create, deploy, and manage data transforms, unit tests, and implementation
      details.
paths:
  /cluster/status:
    get:
      tags:
        - Cluster Scaling
      summary: Get Cluster Status
      description: >-
        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.
      operationId: getClusterStatus
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterStatusResponse'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    ClusterStatusResponse:
      properties:
        current_tier:
          type: string
          title: Current Tier
          description: 'Current active tier: large, xlarge, or unknown'
        kafka_memory:
          type: string
          title: Kafka Memory
        kafka_connect_memory:
          type: string
          title: Kafka Connect Memory
        kafka_connect_replicas:
          type: integer
          title: Kafka Connect Replicas
        node_groups:
          items:
            $ref: '#/components/schemas/NodeGroupStatus'
          type: array
          title: Node Groups
          description: >-
            Node groups for the active tier only, enriched with instance type,
            AZ, and EBS.
        active_operation_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Operation Id
          description: Operation ID if a scaling operation is in progress
      additionalProperties: true
      type: object
      required:
        - current_tier
        - kafka_memory
        - kafka_connect_memory
        - kafka_connect_replicas
      title: ClusterStatusResponse
    NodeGroupStatus:
      properties:
        name:
          type: string
          title: Name
        role:
          type: string
          title: Role
          description: '''kafka'' or ''kafka_connect'''
          default: unknown
        az:
          anyOf:
            - type: string
            - type: 'null'
          title: Az
        instance_type:
          type: string
          title: Instance Type
        vcpu:
          anyOf:
            - type: integer
            - type: 'null'
          title: Vcpu
          description: Per-node vCPU count, resolved from ec2.describe_instance_types.
        memory_gib:
          anyOf:
            - type: integer
            - type: 'null'
          title: Memory Gib
          description: Per-node memory in GiB, resolved from ec2.describe_instance_types.
        desired_size:
          type: integer
          title: Desired Size
        status:
          type: string
          title: Status
          description: 'EKS nodegroup status: ACTIVE, UPDATING, etc.'
        ebs_volumes:
          items:
            $ref: '#/components/schemas/EbsVolumeStatus'
          type: array
          title: Ebs Volumes
          default: []
      additionalProperties: true
      type: object
      required:
        - name
        - instance_type
        - desired_size
        - status
      title: NodeGroupStatus
      description: >-
        Live state of a single node group on the active tier, enriched with role
        + AZ + EBS.
    EbsVolumeStatus:
      properties:
        volume_type:
          type: string
          title: Volume Type
        size_gb:
          type: integer
          title: Size Gb
        iops:
          type: integer
          title: Iops
        throughput_mbps:
          anyOf:
            - type: integer
            - type: 'null'
          title: Throughput Mbps
        volumes_per_node:
          type: integer
          title: Volumes Per Node
          default: 1
      additionalProperties: true
      type: object
      required:
        - volume_type
        - size_gb
        - iops
      title: EbsVolumeStatus
      description: An EBS volume attached to nodes in a node group.
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````