GuidesAPI Reference
API Reference

Commits offsets of the last message read

After reading data, you should commit the offset of the last message read from each partition so that your application can resume reading new messages from the correct partition in the event that there is a disruption to the subscription, such as an application crash. An offset can also be useful if you delete a subscription then recreate a subscription for the same layer, because the new subscription can start reading data from the offset. To read messages already committed, use the /seek endpoint, then use /partitions. 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

The offsets to commit. It should be same as the offset of the message you wish to commit. Do not pass offset + 1 as mentioned in Kafka Consumer documentation. The service adds one to the offset you specify.

offsets
array of objects
offsets
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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