Create a consumer for the group.

POST /consumers/{group_name}

Path parameters

  • group_name string Required
application/vnd.kafka.v2+json

Body

  • format string

    oneOf: ['binary','json']

  • name string

    Name of the consumer

  • auto.offset.reset string

    oneOf: ['earliest']

  • auto.commit.enable string

    oneOf: ['false']

  • fetch.min.bytes string
  • consumer.request.timeout.ms string

Responses

  • 200 application/vnd.kafka.v2+json

    OK

    Hide response attributes Show response attributes object
    • instance_id string
    • base_uri string
  • 409 application/vnd.kafka.v2+json

    Consumer already exists

    Hide response attributes Show response attributes object
    • error_code integer
    • message string
  • 422 application/vnd.kafka.v2+json

    Invalid configuration

    Hide response attributes Show response attributes object
    • error_code integer
    • message string
POST /consumers/{group_name} 
curl \
 --request POST 'http://{{Host}}/consumers/{group_name}' \
 --header "Content-Type: application/vnd.kafka.v2+json"
Request examples 
{
  "format": "string",
  "name": "string",
  "auto.offset.reset": "string",
  "auto.commit.enable": "string",
  "fetch.min.bytes": "string",
  "consumer.request.timeout.ms": "string"
}
Response examples (200) 
{
  "instance_id": "string",
  "base_uri": "string"
}
Response examples (409) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (422) 
{
  "error_code": 42,
  "message": "string"
}