GuidesAPI Reference
API Reference

Enable message consumption from a specific stream layer.

post
https://use.apilookup.for.a.base.url/stream/v2/layers//subscribe

Enables message consumption from a specific stream layer (topic). Use the base path returned from the API Lookup service. Note: For mode = parallel, one unit of parallelism currently equals 1 MBps inbound or 2 MBps outbound, whichever is greater, rounded up to the nearest integer. The number of subscriptions within the same group cannot exceed the parallelism allowed. For more details see Get Data from a Stream Layer.

Path Params
string
required

The ID of the stream layers.

Query Params
string
enum
Defaults to serial

Specifies whether to use serial or parallel subscription mode. For more details see Get Data from a Stream Layer.

Allowed:
string

Include this parameter if you want to look up the nodeBaseURL for a given subscriptionId.

string

The ID to use to identify this consumer. It must be unique within the consumer group. If you do not provide one, the system will generate one.

Body Params
kafkaConsumerProperties
object

This is the same as Kafka Consumer properties with some default values changed.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated last month

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated last month