Chapter 3. AMQ Streams Kafka Bridge API Reference
3.1. Overview Copy linkLink copied to clipboard!
The AMQ Streams Kafka Bridge provides a REST API for integrating HTTP based client applications with a Kafka cluster. You can use the API to create and manage consumers and send and receive records over HTTP rather than the native Kafka protocol.
3.1.1. Version information Copy linkLink copied to clipboard!
Version : 0.1.0
3.1.2. Tags Copy linkLink copied to clipboard!
- Consumers : Consumer operations to create consumers in your Kafka cluster and perform common actions, such as subscribing to topics, retrieving processed records, and committing offsets.
- Producer : Producer operations to send records to a specified topic or topic partition.
- Seek : Seek operations that enable a consumer to begin receiving messages from a given offset position.
- Topics : Topic operations to send messages to a specified topic or topic partition, optionally including message keys in requests. You can also retrieve topics and topic metadata.
3.1.3. Consumes Copy linkLink copied to clipboard!
-
application/json
3.1.4. Produces Copy linkLink copied to clipboard!
-
application/json
3.2. Definitions Copy linkLink copied to clipboard!
3.2.1. AssignedTopicPartitions Copy linkLink copied to clipboard!
Type : < string, < integer (int32) > array > map
3.2.2. BridgeInfo Copy linkLink copied to clipboard!
Information about Kafka Bridge instance.
| Name | Schema |
|---|---|
|
bridge_version | string |
3.2.3. Consumer Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
|
auto.offset.reset |
Resets the offset position for the consumer. If set to | string |
|
consumer.request.timeout.ms | Sets the maximum amount of time, in milliseconds, for the consumer to wait for messages for a request. If the timeout period is reached without a response, an error is returned. | integer |
|
enable.auto.commit |
If set to | boolean |
|
fetch.min.bytes | Sets the minimum ammount of data, in bytes, for the consumer to receive. The broker waits until the data to send exceeds this amount. | integer |
|
format |
The allowable message format for the consumer, which can be | string |
|
isolation.level |
If set to | string |
|
name | The unique name for the consumer instance. The name is unique within the scope of the consumer group. The name is used in URLs. | string |
3.2.4. ConsumerRecord Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
headers | |
|
key | string |
|
offset | integer (int64) |
|
partition | integer (int32) |
|
topic | string |
|
value | string |
3.2.5. ConsumerRecordList Copy linkLink copied to clipboard!
Type : < ConsumerRecord > array
3.2.6. CreatedConsumer Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
|
base_uri | Base URI used to construct URIs for subsequent requests against this consumer instance. | string |
|
instance_id | Unique ID for the consumer instance in the group. | string |
3.2.7. Error Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
error_code | integer (int32) |
|
message | string |
3.2.8. KafkaHeader Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
|
key | string | |
|
value |
The header value in binary format, base64-encoded | string (byte) |
3.2.9. KafkaHeaderList Copy linkLink copied to clipboard!
Type : < KafkaHeader > array
3.2.10. OffsetCommitSeek Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
offset | integer (int64) |
|
partition | integer (int32) |
|
topic | string |
3.2.11. OffsetCommitSeekList Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
offsets | < OffsetCommitSeek > array |
3.2.12. OffsetRecordSent Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
offset | integer (int64) |
|
partition | integer (int32) |
3.2.13. OffsetRecordSentList Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
offsets | < OffsetRecordSent > array |
3.2.14. OffsetsSummary Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
beginning_offset | integer (int64) |
|
end_offset | integer (int64) |
3.2.15. Partition Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
partition | integer (int32) |
|
topic | string |
3.2.16. PartitionMetadata Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
leader | integer (int32) |
|
partition | integer (int32) |
|
replicas | < Replica > array |
3.2.17. Partitions Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
partitions | < Partition > array |
3.2.18. ProducerRecord Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
headers | |
|
partition | integer (int32) |
3.2.19. ProducerRecordList Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
records | < ProducerRecord > array |
3.2.20. ProducerRecordToPartition Copy linkLink copied to clipboard!
Type : object
3.2.21. ProducerRecordToPartitionList Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
records | < ProducerRecordToPartition > array |
3.2.22. Replica Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
broker | integer (int32) |
|
in_sync | boolean |
|
leader | boolean |
3.2.23. SubscribedTopicList Copy linkLink copied to clipboard!
| Name | Schema |
|---|---|
|
partitions | < AssignedTopicPartitions > array |
|
topics |
3.2.24. TopicMetadata Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
|
configs | Per-topic configuration overrides | < string, string > map |
|
name | Name of the topic | string |
|
partitions | < PartitionMetadata > array |
3.2.25. Topics Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
|
topic_pattern | A regex topic pattern for matching multiple topics | string |
|
topics | < string > array |
3.3. Paths Copy linkLink copied to clipboard!
3.3.1. GET / Copy linkLink copied to clipboard!
3.3.1.1. Description Copy linkLink copied to clipboard!
Retrieves information about the Kafka Bridge instance, in JSON format.
3.3.1.2. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Information about Kafka Bridge instance. |
3.3.1.3. Produces Copy linkLink copied to clipboard!
-
application/json
3.3.1.4. Example HTTP response Copy linkLink copied to clipboard!
3.3.1.4.1. Response 200 Copy linkLink copied to clipboard!
{
"bridge_version" : "0.16.0"
}
{
"bridge_version" : "0.16.0"
}
3.3.2. POST /consumers/{groupid} Copy linkLink copied to clipboard!
3.3.2.1. Description Copy linkLink copied to clipboard!
Creates a consumer instance in the given consumer group. You can optionally specify a consumer name and supported configuration options. It returns a base URI which must be used to construct URLs for subsequent requests against this consumer instance.
3.3.2.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group in which to create the consumer. | string |
| Body |
body | Name and configuration of the consumer. The name is unique within the scope of the consumer group. If a name is not specified, a randomly generated name is assigned. All parameters are optional. The supported configuration options are shown in the following example. |
3.3.2.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Consumer created successfully. | |
| 409 | A consumer instance with the specified name already exists in the Kafka Bridge. | |
| 422 | One or more consumer configuration options have invalid values. |
3.3.2.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.2.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.2.6. Tags Copy linkLink copied to clipboard!
- Consumers
3.3.2.7. Example HTTP request Copy linkLink copied to clipboard!
3.3.2.7.1. Request body Copy linkLink copied to clipboard!
3.3.2.8. Example HTTP response Copy linkLink copied to clipboard!
3.3.2.8.1. Response 200 Copy linkLink copied to clipboard!
{
"instance_id" : "consumer1",
"base_uri" : "http://localhost:8080/consumers/my-group/instances/consumer1"
}
{
"instance_id" : "consumer1",
"base_uri" : "http://localhost:8080/consumers/my-group/instances/consumer1"
}
3.3.2.8.2. Response 409 Copy linkLink copied to clipboard!
{
"error_code" : 409,
"message" : "A consumer instance with the specified name already exists in the Kafka Bridge."
}
{
"error_code" : 409,
"message" : "A consumer instance with the specified name already exists in the Kafka Bridge."
}
3.3.2.8.3. Response 422 Copy linkLink copied to clipboard!
{
"error_code" : 422,
"message" : "One or more consumer configuration options have invalid values."
}
{
"error_code" : 422,
"message" : "One or more consumer configuration options have invalid values."
}
3.3.3. DELETE /consumers/{groupid}/instances/{name} Copy linkLink copied to clipboard!
3.3.3.1. Description Copy linkLink copied to clipboard!
Deletes a specified consumer instance. The request for this operation MUST use the base URL (including the host and port) returned in the response from the POST request to /consumers/{groupid} that was used to create this consumer.
3.3.3.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the consumer belongs. | string |
| Path |
name | Name of the consumer to delete. | string |
3.3.3.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Consumer removed successfully. | No Content |
| 404 | The specified consumer instance was not found. |
3.3.3.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.3.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.3.6. Tags Copy linkLink copied to clipboard!
- Consumers
3.3.3.7. Example HTTP response Copy linkLink copied to clipboard!
3.3.3.7.1. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.4. POST /consumers/{groupid}/instances/{name}/assignments Copy linkLink copied to clipboard!
3.3.4.1. Description Copy linkLink copied to clipboard!
Assigns one or more topic partitions to a consumer.
3.3.4.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the consumer belongs. | string |
| Path |
name | Name of the consumer to assign topic partitions to. | string |
| Body |
body | List of topic partitions to assign to the consumer. |
3.3.4.3. Responses Copy linkLink copied to clipboard!
3.3.4.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.4.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.4.6. Tags Copy linkLink copied to clipboard!
- Consumers
3.3.4.7. Example HTTP request Copy linkLink copied to clipboard!
3.3.4.7.1. Request body Copy linkLink copied to clipboard!
3.3.4.8. Example HTTP response Copy linkLink copied to clipboard!
3.3.4.8.1. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.4.8.2. Response 409 Copy linkLink copied to clipboard!
{
"error_code" : 409,
"message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
{
"error_code" : 409,
"message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
3.3.5. POST /consumers/{groupid}/instances/{name}/offsets Copy linkLink copied to clipboard!
3.3.5.1. Description Copy linkLink copied to clipboard!
Commits a list of consumer offsets. To commit offsets for all records fetched by the consumer, leave the request body empty.
3.3.5.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the consumer belongs. | string |
| Path |
name | Name of the consumer. | string |
| Body |
body | List of consumer offsets to commit to the consumer offsets commit log. You can specify one or more topic partitions to commit offsets for. |
3.3.5.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Commit made successfully. | No Content |
| 404 | The specified consumer instance was not found. |
3.3.5.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.5.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.5.6. Tags Copy linkLink copied to clipboard!
- Consumers
3.3.5.7. Example HTTP request Copy linkLink copied to clipboard!
3.3.5.7.1. Request body Copy linkLink copied to clipboard!
3.3.5.8. Example HTTP response Copy linkLink copied to clipboard!
3.3.5.8.1. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.6. POST /consumers/{groupid}/instances/{name}/positions Copy linkLink copied to clipboard!
3.3.6.1. Description Copy linkLink copied to clipboard!
Configures a subscribed consumer to fetch offsets from a particular offset the next time it fetches a set of records from a given topic partition. This overrides the default fetch behavior for consumers. You can specify one or more topic partitions.
3.3.6.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the consumer belongs. | string |
| Path |
name | Name of the subscribed consumer. | string |
| Body |
body | List of partition offsets from which the subscribed consumer will next fetch records. |
3.3.6.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Seek performed successfully. | No Content |
| 404 | The specified consumer instance was not found, or the specified consumer instance did not have one of the specified partitions assigned. |
3.3.6.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.6.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.6.6. Tags Copy linkLink copied to clipboard!
- Consumers
- Seek
3.3.6.7. Example HTTP request Copy linkLink copied to clipboard!
3.3.6.7.1. Request body Copy linkLink copied to clipboard!
3.3.6.8. Example HTTP response Copy linkLink copied to clipboard!
3.3.6.8.1. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.7. POST /consumers/{groupid}/instances/{name}/positions/beginning Copy linkLink copied to clipboard!
3.3.7.1. Description Copy linkLink copied to clipboard!
Configures a subscribed consumer to seek (and subsequently read from) the first offset in one or more given topic partitions.
3.3.7.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the subscribed consumer belongs. | string |
| Path |
name | Name of the subscribed consumer. | string |
| Body |
body | List of topic partitions to which the consumer is subscribed. The consumer will seek the first offset in the specified partitions. |
3.3.7.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Seek to the beginning performed successfully. | No Content |
| 404 | The specified consumer instance was not found, or the specified consumer instance did not have one of the specified partitions assigned. |
3.3.7.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.7.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.7.6. Tags Copy linkLink copied to clipboard!
- Consumers
- Seek
3.3.7.7. Example HTTP request Copy linkLink copied to clipboard!
3.3.7.7.1. Request body Copy linkLink copied to clipboard!
3.3.7.8. Example HTTP response Copy linkLink copied to clipboard!
3.3.7.8.1. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.8. POST /consumers/{groupid}/instances/{name}/positions/end Copy linkLink copied to clipboard!
3.3.8.1. Description Copy linkLink copied to clipboard!
Configures a subscribed consumer to seek (and subsequently read from) the offset at the end of one or more of the given topic partitions.
3.3.8.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the subscribed consumer belongs. | string |
| Path |
name | Name of the subscribed consumer. | string |
| Body |
body | List of topic partitions to which the consumer is subscribed. The consumer will seek the last offset in the specified partitions. |
3.3.8.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Seek to the end performed successfully. | No Content |
| 404 | The specified consumer instance was not found, or the specified consumer instance did not have one of the specified partitions assigned. |
3.3.8.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.8.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.8.6. Tags Copy linkLink copied to clipboard!
- Consumers
- Seek
3.3.8.7. Example HTTP request Copy linkLink copied to clipboard!
3.3.8.7.1. Request body Copy linkLink copied to clipboard!
3.3.8.8. Example HTTP response Copy linkLink copied to clipboard!
3.3.8.8.1. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.9. GET /consumers/{groupid}/instances/{name}/records Copy linkLink copied to clipboard!
3.3.9.1. Description Copy linkLink copied to clipboard!
Retrieves records for a subscribed consumer, including message values, topics, and partitions. The request for this operation MUST use the base URL (including the host and port) returned in the response from the POST request to /consumers/{groupid} that was used to create this consumer.
3.3.9.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the subscribed consumer belongs. | string |
| Path |
name | Name of the subscribed consumer to retrieve records from. | string |
| Query |
max_bytes | The maximum size, in bytes, of unencoded keys and values that can be included in the response. Otherwise, an error response with code 422 is returned. | integer |
| Query |
timeout | The maximum amount of time, in milliseconds, that the HTTP Bridge spends retrieving records before timing out the request. | integer |
3.3.9.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Poll request executed successfully. | |
| 404 | The specified consumer instance was not found. | |
| 406 |
The | |
| 422 | Response exceeds the maximum number of bytes the consumer can receive |
3.3.9.4. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.json.v2+json -
application/vnd.kafka.binary.v2+json -
application/vnd.kafka.v2+json
3.3.9.5. Tags Copy linkLink copied to clipboard!
- Consumers
3.3.9.6. Example HTTP response Copy linkLink copied to clipboard!
3.3.9.6.1. Response 200 Copy linkLink copied to clipboard!
3.3.9.6.2. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.9.6.3. Response 406 Copy linkLink copied to clipboard!
{
"error_code" : 406,
"message" : "The `format` used in the consumer creation request does not match the embedded format in the Accept header of this request."
}
{
"error_code" : 406,
"message" : "The `format` used in the consumer creation request does not match the embedded format in the Accept header of this request."
}
3.3.9.6.4. Response 422 Copy linkLink copied to clipboard!
{
"error_code" : 422,
"message" : "Response exceeds the maximum number of bytes the consumer can receive"
}
{
"error_code" : 422,
"message" : "Response exceeds the maximum number of bytes the consumer can receive"
}
3.3.10. POST /consumers/{groupid}/instances/{name}/subscription Copy linkLink copied to clipboard!
3.3.10.1. Description Copy linkLink copied to clipboard!
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.
3.3.10.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the subscribed consumer belongs. | string |
| Path |
name | Name of the consumer to subscribe to topics. | string |
| Body |
body | List of topics to which the consumer will subscribe. |
3.3.10.3. Responses Copy linkLink copied to clipboard!
3.3.10.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.10.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.10.6. Tags Copy linkLink copied to clipboard!
- Consumers
3.3.10.7. Example HTTP request Copy linkLink copied to clipboard!
3.3.10.7.1. Request body Copy linkLink copied to clipboard!
{
"topics" : [ "topic1", "topic2" ]
}
{
"topics" : [ "topic1", "topic2" ]
}
3.3.10.8. Example HTTP response Copy linkLink copied to clipboard!
3.3.10.8.1. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.10.8.2. Response 409 Copy linkLink copied to clipboard!
{
"error_code" : 409,
"message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
{
"error_code" : 409,
"message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
3.3.10.8.3. Response 422 Copy linkLink copied to clipboard!
{
"error_code" : 422,
"message" : "A list (of Topics type) or a topic_pattern must be specified."
}
{
"error_code" : 422,
"message" : "A list (of Topics type) or a topic_pattern must be specified."
}
3.3.11. GET /consumers/{groupid}/instances/{name}/subscription Copy linkLink copied to clipboard!
3.3.11.1. Description Copy linkLink copied to clipboard!
Retrieves a list of the topics to which the consumer is subscribed.
3.3.11.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the subscribed consumer belongs. | string |
| Path |
name | Name of the subscribed consumer. | string |
3.3.11.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | List of subscribed topics and partitions. | |
| 404 | The specified consumer instance was not found. |
3.3.11.4. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.11.5. Tags Copy linkLink copied to clipboard!
- Consumers
3.3.11.6. Example HTTP response Copy linkLink copied to clipboard!
3.3.11.6.1. Response 200 Copy linkLink copied to clipboard!
3.3.11.6.2. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.12. DELETE /consumers/{groupid}/instances/{name}/subscription Copy linkLink copied to clipboard!
3.3.12.1. Description Copy linkLink copied to clipboard!
Unsubscribes a consumer from all topics.
3.3.12.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
groupid | ID of the consumer group to which the subscribed consumer belongs. | string |
| Path |
name | Name of the consumer to unsubscribe from topics. | string |
3.3.12.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Consumer unsubscribed successfully. | No Content |
| 404 | The specified consumer instance was not found. |
3.3.12.4. Tags Copy linkLink copied to clipboard!
- Consumers
3.3.12.5. Example HTTP response Copy linkLink copied to clipboard!
3.3.12.5.1. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.3.13. GET /healthy Copy linkLink copied to clipboard!
3.3.13.1. Description Copy linkLink copied to clipboard!
Check if the bridge is running. This does not necessarily imply that it is ready to accept requests.
3.3.13.2. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | The bridge is healthy | No Content |
3.3.14. GET /openapi Copy linkLink copied to clipboard!
3.3.14.1. Description Copy linkLink copied to clipboard!
Retrieves the OpenAPI v2 specification in JSON format.
3.3.14.2. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OpenAPI v2 specification in JSON format retrieved successfully. | string |
3.3.14.3. Produces Copy linkLink copied to clipboard!
-
application/json
3.3.15. GET /ready Copy linkLink copied to clipboard!
3.3.15.1. Description Copy linkLink copied to clipboard!
Check if the bridge is ready and can accept requests.
3.3.15.2. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | The bridge is ready | No Content |
3.3.16. GET /topics Copy linkLink copied to clipboard!
3.3.16.1. Description Copy linkLink copied to clipboard!
Retrieves a list of all topics.
3.3.16.2. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | List of topics. | < string > array |
3.3.16.3. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.16.4. Tags Copy linkLink copied to clipboard!
- Topics
3.3.16.5. Example HTTP response Copy linkLink copied to clipboard!
3.3.16.5.1. Response 200 Copy linkLink copied to clipboard!
[ "topic1", "topic2" ]
[ "topic1", "topic2" ]
3.3.17. POST /topics/{topicname} Copy linkLink copied to clipboard!
3.3.17.1. Description Copy linkLink copied to clipboard!
Sends one or more records to a given topic, optionally specifying a partition, key, or both.
3.3.17.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
topicname | Name of the topic to send records to or retrieve metadata from. | string |
| Body |
body |
3.3.17.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Records sent successfully. | |
| 404 | The specified topic was not found. | |
| 422 | The record list is not valid. |
3.3.17.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.json.v2+json -
application/vnd.kafka.binary.v2+json
3.3.17.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.17.6. Tags Copy linkLink copied to clipboard!
- Producer
- Topics
3.3.17.7. Example HTTP request Copy linkLink copied to clipboard!
3.3.17.7.1. Request body Copy linkLink copied to clipboard!
3.3.17.8. Example HTTP response Copy linkLink copied to clipboard!
3.3.17.8.1. Response 200 Copy linkLink copied to clipboard!
3.3.17.8.2. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
3.3.17.8.3. Response 422 Copy linkLink copied to clipboard!
{
"error_code" : 422,
"message" : "The record list contains invalid records."
}
{
"error_code" : 422,
"message" : "The record list contains invalid records."
}
3.3.18. GET /topics/{topicname} Copy linkLink copied to clipboard!
3.3.18.1. Description Copy linkLink copied to clipboard!
Retrieves the metadata about a given topic.
3.3.18.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
topicname | Name of the topic to send records to or retrieve metadata from. | string |
3.3.18.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Topic metadata |
3.3.18.4. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.18.5. Tags Copy linkLink copied to clipboard!
- Topics
3.3.18.6. Example HTTP response Copy linkLink copied to clipboard!
3.3.18.6.1. Response 200 Copy linkLink copied to clipboard!
3.3.19. GET /topics/{topicname}/partitions Copy linkLink copied to clipboard!
3.3.19.1. Description Copy linkLink copied to clipboard!
Retrieves a list of partitions for the topic.
3.3.19.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
topicname | Name of the topic to send records to or retrieve metadata from. | string |
3.3.19.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | List of partitions | < PartitionMetadata > array |
| 404 | The specified topic was not found. |
3.3.19.4. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.19.5. Tags Copy linkLink copied to clipboard!
- Topics
3.3.19.6. Example HTTP response Copy linkLink copied to clipboard!
3.3.19.6.1. Response 200 Copy linkLink copied to clipboard!
3.3.19.6.2. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
3.3.20. POST /topics/{topicname}/partitions/{partitionid} Copy linkLink copied to clipboard!
3.3.20.1. Description Copy linkLink copied to clipboard!
Sends one or more records to a given topic partition, optionally specifying a key.
3.3.20.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
partitionid | ID of the partition to send records to or retrieve metadata from. | integer |
| Path |
topicname | Name of the topic to send records to or retrieve metadata from. | string |
| Body |
body | List of records to send to a given topic partition, including a value (required) and a key (optional). |
3.3.20.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Records sent successfully. | |
| 404 | The specified topic partition was not found. | |
| 422 | The record is not valid. |
3.3.20.4. Consumes Copy linkLink copied to clipboard!
-
application/vnd.kafka.json.v2+json -
application/vnd.kafka.binary.v2+json
3.3.20.5. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.20.6. Tags Copy linkLink copied to clipboard!
- Producer
- Topics
3.3.20.7. Example HTTP request Copy linkLink copied to clipboard!
3.3.20.7.1. Request body Copy linkLink copied to clipboard!
3.3.20.8. Example HTTP response Copy linkLink copied to clipboard!
3.3.20.8.1. Response 200 Copy linkLink copied to clipboard!
3.3.20.8.2. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
3.3.20.8.3. Response 422 Copy linkLink copied to clipboard!
{
"error_code" : 422,
"message" : "The record is not valid."
}
{
"error_code" : 422,
"message" : "The record is not valid."
}
3.3.21. GET /topics/{topicname}/partitions/{partitionid} Copy linkLink copied to clipboard!
3.3.21.1. Description Copy linkLink copied to clipboard!
Retrieves partition metadata for the topic partition.
3.3.21.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
partitionid | ID of the partition to send records to or retrieve metadata from. | integer |
| Path |
topicname | Name of the topic to send records to or retrieve metadata from. | string |
3.3.21.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Partition metadata | |
| 404 | The specified topic partition was not found. |
3.3.21.4. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.21.5. Tags Copy linkLink copied to clipboard!
- Topics
3.3.21.6. Example HTTP response Copy linkLink copied to clipboard!
3.3.21.6.1. Response 200 Copy linkLink copied to clipboard!
3.3.21.6.2. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
3.3.22. GET /topics/{topicname}/partitions/{partitionid}/offsets Copy linkLink copied to clipboard!
3.3.22.1. Description Copy linkLink copied to clipboard!
Retrieves a summary of the offsets for the topic partition.
3.3.22.2. Parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| Path |
partitionid | ID of the partition. | integer |
| Path |
topicname | Name of the topic containing the partition. | string |
3.3.22.3. Responses Copy linkLink copied to clipboard!
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | A summary of the offsets for the topic partition. | |
| 404 | The specified topic partition was not found. |
3.3.22.4. Produces Copy linkLink copied to clipboard!
-
application/vnd.kafka.v2+json
3.3.22.5. Tags Copy linkLink copied to clipboard!
- Topics
3.3.22.6. Example HTTP response Copy linkLink copied to clipboard!
3.3.22.6.1. Response 200 Copy linkLink copied to clipboard!
{
"beginning_offset" : 10,
"end_offset" : 50
}
{
"beginning_offset" : 10,
"end_offset" : 50
}
3.3.22.6.2. Response 404 Copy linkLink copied to clipboard!
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}