v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0172165343.2 KB

Msgs

Sink Configure

Create or update a sink for a topic. Overwrites any existing sink with the same id.

post/api/v1.msgs.sink.configure

Request body

namespacestring nullable

topicstring required

The topic whose messages are forwarded to the sink. Created automatically if it does not exist.

consumer_groupstring required

The consumer group that identifies the sink and tracks its progress through the topic.

default_starting_position'earliest' | 'latest'

max_in_flightinteger nullable

At most how many concurrent requests will be sent to the Sink.

Example request

{
  "namespace": "some_namespace",
  "topic": "some_topic_name",
  "consumer_group": "some_consumer_group",
  "config": {
    "data": {
      "url": "My name is ${name}!",
      "body": "My name is ${name}!"
    }
  }
}

Response

topicstring required

consumer_groupstring required

Example response

{
  "topic": "some_topic_name",
  "consumer_group": "some_consumer_group"
}