StreamNative Ksn Consumer Group API

The ksn-consumer-group API from StreamNative — 4 operation(s) for ksn-consumer-group.

Documentation GitHub OpenAPI

Operations 4

GET /admin/v1/consumer-groups Return the list of consumer groups #

GET /admin/v1/consumer-groups/{consumer_group_id}/lags Return a list of consumer lags of the consumers belonging to the specified… #

GET /admin/v1/consumer-groups/{consumer_group_id} Return the consumer group specified by the consumer_group_id #

GET /admin/v1/consumer-groups/{consumer_group_id}/consumers Return a list of consumers that belong to the specified consumer group #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/streamnative:streamnative-ksn-consumer-group-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Streamnative Ksn Consumer Group API
  version: v1
  description: 'Operations tagged ksn-consumer-group across 2 of this provider''s published API definitions: kafka-rest-api-v1.json, streamnative-kafka-rest-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{httpServiceUrl}/rest-kafka
  description: Per-cluster HTTP service URL (docs.streamnative.io/cloud/build/kafka-clients/kafka-rest-api)
  variables:
    httpServiceUrl:
      default: your-http-service-url-tls
tags:
- name: ksn-consumer-group
paths:
  /admin/v1/consumer-groups:
    get:
      tags:
      - ksn-consumer-group
      summary: Return the list of consumer groups
      description: Lists all consumer groups in the Kafka cluster. Returns a collection of consumer group objects with their basic metadata.
      operationId: listConsumerGroups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaConsumerGroupList'
        '400':
          description: Wrong request params
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
  /admin/v1/consumer-groups/{consumer_group_id}/lags:
    get:
      tags:
      - ksn-consumer-group
      summary: Return a list of consumer lags of the consumers belonging to the specified…
      description: Retrieves consumer lag information for all topic partitions consumed by the specified consumer group. Lag represents the difference between the latest offset and the consumer's current position.
      operationId: getConsumerGroupLags
      parameters:
      - name: consumer_group_id
        in: path
        description: The consumer group ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaConsumerLagList'
        '400':
          description: Wrong request params
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
  /admin/v1/consumer-groups/{consumer_group_id}:
    get:
      tags:
      - ksn-consumer-group
      summary: Return the consumer group specified by the consumer_group_id
      description: Gets detailed information about a specific consumer group identified by its ID. Returns consumer group metadata including state, members, and assigned partitions.
      operationId: listConsumerGroupsSpecifiedByTheConsumerGroupId
      parameters:
      - name: consumer_group_id
        in: path
        description: The consumer group ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaConsumerGroup'
        '400':
          description: Wrong request params
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
  /admin/v1/consumer-groups/{consumer_group_id}/consumers:
    get:
      tags:
      - ksn-consumer-group
      summary: Return a list of consumers that belong to the specified consumer group
      description: Lists all active consumers that are members of the specified consumer group. Includes consumer metadata such as client ID, host, and partition assignments.
      operationId: listConsumersBySpecifiedConsumerGroup
      parameters:
      - name: consumer_group_id
        in: path
        description: The consumer group ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaConsumerList'
        '400':
          description: Wrong request params
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
components:
  schemas:
    Metadata:
      type: object
    KafkaConsumer:
      type: object
      properties:
        consumer_group_id:
          type: string
        consumer_id:
          type: string
        client_id:
          type: string
        host:
          type: string
        metadata:
          $ref: '#/components/schemas/Metadata'
        kind:
          type: string
    KafkaConsumerList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/KafkaConsumer'
        metadata:
          $ref: '#/components/schemas/Metadata'
        kind:
          type: string
    KafkaConsumerLagList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/KafkaConsumerLag'
        metadata:
          $ref: '#/components/schemas/Metadata'
        kind:
          type: string
    KafkaConsumerGroupList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/KafkaConsumerGroup'
        metadata:
          $ref: '#/components/schemas/Metadata'
        kind:
          type: string
    KafkaConsumerLag:
      type: object
      properties:
        consumer_group_id:
          type: string
        topic_name:
          type: string
        partition_id:
          type: integer
          format: int32
        consumer_id:
          type: string
        host:
          type: string
        client_id:
          type: string
        current_offset:
          type: integer
          format: int64
        log_end_offset:
          type: integer
          format: int64
        lag:
          type: integer
          format: int64
        metadata:
          $ref: '#/components/schemas/Metadata'
        kind:
          type: string
    KafkaConsumerGroup:
      type: object
      properties:
        consumer_group_id:
          type: string
        partition_assignor:
          type: string
        state:
          type: string
        type:
          type: string
        metadata:
          $ref: '#/components/schemas/Metadata'
        simple:
          type: boolean
        kind:
          type: string
x-refined-from:
- kafka-rest-api-v1.json
- streamnative-kafka-rest-openapi.yml