Msgs

Queue Extend Lease

Extends the lease on in-flight messages.

Consumers that need more processing time can call this before the lease expires to prevent the message from being re-delivered to another consumer.

post/api/v1.msgs.queue.extend-lease

Request body

namespacestring nullable
topicstring required
consumer_groupstring required
msg_idsstring[] required
lease_duration_msinteger

Example request

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

Response

MsgQueueExtendLeaseOut required

Changes

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

  • 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

    • 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

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

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