Msgs

Stream Seek

Repositions a consumer group's read cursor on a topic.

Provide exactly one of offset, position, or timestamp. When using offset, the topic must include a partition suffix (e.g. ns:my-topic~0). The position field accepts "earliest" or "latest" and may be used with or without a partition suffix. The timestamp field accepts a Unix timestamp in milliseconds and seeks to the first message at or after that time.

post/api/v1.msgs.stream.seek

Request body

namespacestring nullable
topicstring required
consumer_groupstring required
offsetinteger nullable
position'earliest' | 'latest'
timestampinteger nullable

Example request

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

Response

MsgStreamSeekOut required

Changes

Changed in 7 of the 53 revisions of this API.91824

  • a542ced3f5931212See the full diff
    • added the new invalid-input enum value to the type response property for the response status 400

      response-property-enum-value-added

    • added the new invalid-input enum value to the type response property for the response status 401

      response-property-enum-value-added

    • added the new invalid-input enum value to the type response property for the response status 403

      response-property-enum-value-added

    • added the new invalid-input enum value to the type response property for the response status 422

      response-property-enum-value-added

    • added the new operation-error enum value to the type response property for the response status 400

      response-property-enum-value-added

    • added the new operation-error enum value to the type response property for the response status 401

      response-property-enum-value-added

    • added the new operation-error enum value to the type response property for the response status 403

      response-property-enum-value-added

    • added the new operation-error enum value to the type response property for the response status 422

      response-property-enum-value-added

    • added the new server-error enum value to the type response property for the response status 400

      response-property-enum-value-added

    • added the new server-error enum value to the type response property for the response status 401

      response-property-enum-value-added

    • added the new server-error enum value to the type response property for the response status 403

      response-property-enum-value-added

    • added the new server-error enum value to the type response property for the response status 422

      response-property-enum-value-added

    • removed the invalid_input enum value from the type response property for the response status 400

      response-property-enum-value-removed

    • removed the invalid_input enum value from the type response property for the response status 401

      response-property-enum-value-removed

    • removed the invalid_input enum value from the type response property for the response status 403

      response-property-enum-value-removed

    • removed the invalid_input enum value from the type response property for the response status 422

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 400

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 401

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 403

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 422

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 400

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 401

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 403

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 422

      response-property-enum-value-removed

    • added the required property type to the response with the 400 status

      response-required-property-added

    • added the required property type to the response with the 401 status

      response-required-property-added

    • added the required property type to the response with the 403 status

      response-required-property-added

    • added the required property type to the response with the 422 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c3022218176815See the full diff
    • the detail response's property type/format changed from array/ to string/ for status 422

      response-property-type-changed

    • added the optional property location to the response with the 400 status

      response-optional-property-added

    • added the optional property location to the response with the 401 status

      response-optional-property-added

    • added the optional property location to the response with the 403 status

      response-optional-property-added

    • added the optional property location to the response with the 422 status

      response-optional-property-added

    • added the required property code to the response with the 422 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property timestamp

      new-optional-request-property

    • the namespace request property's minLength was increased from 0 to 1

      request-property-min-length-increased

  • 14bcce06404b11See the full diff
    • added the pattern ^[a-zA-Z0-9\-/_.=+]+$ to the request property namespace

      request-property-pattern-added

    • the namespace request property's maxLength was set to 256

      request-property-max-length-set

  • f62be26d2a53652See the full diff
    • the detail response's property type/format changed from string/ to array/ for status 422

      response-property-type-changed

    • removed the required property code from the response with the 422 status

      response-required-property-removed

    • removed the required property type from the response with the 400 status

      response-required-property-removed

    • removed the required property type from the response with the 401 status

      response-required-property-removed

    • removed the required property type from the response with the 403 status

      response-required-property-removed

    • removed the required property type from the response with the 422 status

      response-required-property-removed

    • removed the request property timestamp

      request-property-removed

    • removed the optional property location from the response with the 400 status

      response-optional-property-removed

    • removed the optional property location from the response with the 401 status

      response-optional-property-removed

    • removed the optional property location from the response with the 403 status

      response-optional-property-removed

    • removed the optional property location from the response with the 422 status

      response-optional-property-removed

    • the namespace request property's minLength was decreased from 1 to 0

      request-property-min-length-decreased

    • removed the pattern ^[a-zA-Z0-9\-/_.=+]+$ from the request property namespace

      request-property-pattern-removed

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog