Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
stream

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.

put/layers/{layerId}/offsets

Path parameters

layerIdstring required

The ID of the parent layer for this blob.

Query parameters

subscriptionIdstring

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

mode'serial' | 'parallel'

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

Request body

Example request

{
  "offsets": [
    {
      "partition": 7,
      "offset": 38562
    }
  ]
}

Response

OK, offsets committed