UPupstash
Messages

Bulk Cancel Messages

Changed on

Delete all pending messages

delete/v2/messages

Request

Query parameters

messageIdsstring[]

A list of message IDs to delete. If provided, other filters are ignored.

topicNamestring[]

Filter messages by URL Group name. Supports multiple values.

queueNamestring[]

Filter messages by Queue name. Supports multiple values.

urlstring[]

Filter messages by destination URL. Supports multiple values.

hoststring[]

Filter messages by the host of the destination URL. Supports multiple values.

pathstring[]

Filter messages by the path of the destination URL. Supports multiple values.

labelstring[]

Filter messages by label. Supports multiple values. You can pass multiple values to match messages with any of the given labels (OR logic).

Examples:

  • label=my_label
  • label=label_1&label=label_2
  • label=label_1,label_2
flowControlKeystring[]

Filter messages by Flow Control Key. Supports multiple values.

fromDateinteger

Filter messages created after this timestamp (Unix milli, inclusive).

toDateinteger

Filter messages created before this timestamp (Unix milli, inclusive).

scheduleIdstring[]

Filter messages by Schedule ID. Supports multiple values.

callerIpstring[]

Filter messages by the IP address of the publisher. Supports multiple values.

callerIPstring[]

Deprecated. Use callerIp instead.

asyncboolean

Only applies to filter-based cancels. If true, the request returns as soon as the bulk action is created, without waiting for it to finish. The response includes the actionId of the bulk action.

countinteger

Deprecated. This parameter is ignored, and all messages matching the filters are cancelled.

Response

Messages cancelled, or the bulk action is created when async=true.

cancelledinteger

When cancelling by messageIds, the number of messages cancelled.

For filter-based cancels, the number of in-progress messages that matched the filters when the request was accepted.

actionIdstring

The ID of the bulk action. Only returned for filter-based cancels with async=true.

Changes

  • ed23e37f87f3Revision changes
    • breaking

      removed the success response with the status

    • info

      added the new optional query request parameter async

    • info

      query request parameter count was deprecated

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status

  • 6afae1d18547Revision changes
    • warning

      for the query request parameter count, the max was set to 500.00

    • warning

      for the query request parameter count, the min was set to 1.00

    • info

      added the new optional query request parameter callerIp

    • info

      added the new optional query request parameter host

    • info

      added the new optional query request parameter path

    • info

      query request parameter callerIP was deprecated

    • info

      for the query request parameter callerIP, the type was generalized from string to array

    • info

      for the query request parameter flowControlKey, the type was generalized from string to array

    • info

      for the query request parameter queueName, the type was generalized from string to array

    • info

      for the query request parameter scheduleId, the type was generalized from string to array

    • info

      for the query request parameter topicName, the type was generalized from string to array

    • info

      for the query request parameter url, the type was generalized from string to array