Skip to main content
API docs by Redocly

Pandaproxy API (0.0.2)

Get a list of brokers.

Responses

Response samples

Content type
application/vnd.kafka.v2+json
[
  • 0
]

Create a consumer for the group.

path Parameters
group_name
required
string
Request Body schema: application/vnd.kafka.v2+json
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

Request samples

Content type
application/vnd.kafka.v2+json
{
  • "format": "string",
  • "name": "string",
  • "auto.offset.reset": "string",
  • "auto.commit.enable": "string",
  • "fetch.min.bytes": "string",
  • "consumer.request.timeout.ms": "string"
}

Response samples

Content type
application/vnd.kafka.v2+json
{
  • "instance_id": "string",
  • "base_uri": "string"
}

Remove a consumer for the group.

path Parameters
group_name
required
string
instance
required
string

Responses

Response samples

Content type
application/vnd.kafka.v2+json
{
  • "error_code": 0,
  • "message": "string"
}

Get committed group offsets for given partitions.

path Parameters
group_name
required
string
instance
required
string
Request Body schema: application/vnd.kafka.v2+json
Array of objects
Array
topic
string
partition
integer

Responses

Request samples

Content type
application/vnd.kafka.v2+json
{
  • "partitions": [
    ]
}

Response samples

Content type
application/vnd.kafka.v2+json
{
  • "offsets": [
    ]
}

Commit offsets for a consumer.

path Parameters
group_name
required
string
instance
required
string
Request Body schema: application/vnd.kafka.v2+json
Array of objects
Array
topic
string
partition
integer
offset
integer

Responses

Request samples

Content type
application/vnd.kafka.v2+json
{
  • "partitions": [
    ]
}

Response samples

Content type
application/vnd.kafka.v2+json
{
  • "error_code": 0,
  • "message": "string"
}

Fetch data for the consumer assignments.

path Parameters
group_name
required
string
instance
required
string
query Parameters
timeout
integer
max_bytes
integer

Responses

Response samples

Content type
{
  • "records": [
    ]
}

Subscribe a consumer group to topics.

path Parameters
group_name
required
string
instance
required
string
Request Body schema: application/vnd.kafka.v2+json
Array
string

Responses

Request samples

Content type
application/vnd.kafka.v2+json
[
  • "string"
]

Get a list of Kafka topics.

Responses

Response samples

Content type
application/vnd.kafka.v2+json
[
  • "string"
]

Produce messages to a topic.

path Parameters
topic_name
required
string
Request Body schema:
Array of objects
Array
key
string
value
string
partition
integer

Responses

Request samples

Content type
{
  • "records": [
    ]
}

Response samples

Content type
application/vnd.kafka.v2+json
{
  • "offsets": [
    ]
}

Get records from a topic.

path Parameters
topic_name
required
string
partition_id
required
integer
query Parameters
offset
required
integer
timeout
required
integer
max_bytes
required
integer

Responses

Response samples

Content type
{
  • "records": [
    ]
}