Red Hat Streams for Apache Kafka Bridge API

HTTP bridge API for producing and consuming messages to Apache Kafka topics without requiring a native Kafka client, deployed as part of Red Hat Streams for Apache Kafka on OpenShift.

Provider Profile APIs.io AsyncAPI GitHub

This event API exposes 3 operations across 2 channels, and defines 7 schemas. It is described by AsyncAPI 2.6.0, at version 3.1.

The API connects through a single server, {bridge_url} (https).

3 operations 2 channels 7 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification

AsyncAPI 2.6.0

API Version

3.1

Server

{bridge_url} (https)

Contact

Red Hat Support

License

Red Hat Terms of Use

Resource Areas

Channels & Operations 3

Across 2 channels, the API surfaces 3 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 3

SUB

topics.{topic}.messages

Consume message from topic

consumeMessage 1 param body

PUB

topics.{topic}.messages

Produce message to topic

produceMessage 1 param body

PUB

consumers.{group_id}.offsets

Commit consumer offsets

commitOffsets 1 param body

Messages & Schemas 7

The contract defines 7 schemas that model the data carried by its messages. The most detailed are ConsumerRecordPayload (6 properties), OffsetCommitPayload (1 property), ProducerRecordPayload (1 property). Each schema is shown below with its type and property counts.

ProducerRecord

message

A single message to be produced to a Kafka topic.

ProducerRecordBatch

message

A batch of messages to be produced to a Kafka topic.

ConsumerRecord

message

A message consumed from a Kafka topic.

OffsetCommit

message

Offset commit request for a consumer group.

ProducerRecordPayload

object

The payload for producing messages to a Kafka topic through the HTTP bridge.

1 property 1 required

ConsumerRecordPayload

object

The payload of a message consumed from a Kafka topic through the HTTP bridge.

6 properties

OffsetCommitPayload

object

The payload for committing consumer offsets.

1 property

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

#Data Integration#Event Streaming#Kafka#Messaging

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Red Hat Streams for Apache Kafka Bridge API

Metadata

Channels & Operations 3

Messages & Schemas 7

Specification

Source

API Details

Provider

Explore more