STstrimzi
Consumers

POST /consumers/{groupid}/instances/{name}/subscription

Changed on

Subscribes a consumer to one or more topics. You can describe the topics to which the consumer will subscribe in a list (of Topics type) or as a topic_pattern field. Each call replaces the subscriptions for the subscriber.

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

groupidstring required

ID of the consumer group to which the subscribed consumer belongs.

namestring required

Name of the consumer to subscribe to topics.

Request body

topicsstring[]

List of topic names to subscribe to.

topic_patternstring

A regex topic pattern for matching multiple topics.

Example request

{
  "topics": [
    "topic1",
    "topic2"
  ]
}

Response

Consumer subscribed successfully.

Changes

  • 426d9b9215e9Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • c8cc23cb8d01Revision changes
    • breaking

      added the new path request parameter groupid

    • breaking

      added the new path request parameter name