GuidesAPI Reference
API Reference

Seek to predefined offset.

put
https://use.apilookup.for.a.base.url/stream/v2/layers//seek

Enables you to start reading data from a specified offset. You can move the message pointer to any offset in the layer (topic). Message consumption will start from that offset. Once you seek to an offset, there is no returning to the initial offset, unless the initial offset is saved. The base path to use is the value of 'nodeBaseURL' returned from /subscribe POST request.

Path Params
string
required

The ID of the stream layers.

Query Params
string

The subscriptionId received in the response of the /subscribe request (required if mode=parallel).

string
enum
Defaults to serial

The subscription mode of this subscriptionId (as provided in /subscribe POST API).

Allowed:
Body Params

List of offsets and offset partitions

offsets
array of objects
offsets
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