Bulk Cancel Messages - Upstash Documentation

Cancelling a message will remove it from QStash and stop it from being delivered in the future. If a message is in flight to your API, it might be too late to cancel.

If you provide a set of message IDs in the request, only those messages will be cancelled.If you include filter parameters in the request, only the messages that match the filters will be canceled.If no filter or messageIds are sent, QStash will cancel all of your messages. We highly recommend at least providing count parameter and cancel in batches.

This operation scans all your messages and attempts to cancel them. If an individual message cannot be cancelled, it will not continue and will return an error message. Therefore, some messages may not be cancelled at the end. In such cases, you can run the bulk cancel operation multiple times.

Authorizations

Authorization

string

header

required

QStash authentication token

Query Parameters

messageIds

string[]

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

topicName

string

Filter messages by URL Group name.

queueName

string

Filter messages by Queue name.

url

string

Filter messages by URL.

label

string

Filter messages by label.

flowControlKey

string

Filter messages by Flow Control Key.

fromDate

integer

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

toDate

integer

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

scheduleId

string

Filter messages by Schedule ID.

callerIP

string

Filter messages by Caller IP.

count

integer

Maximum number of messages to delete. There is no default value, so if not provided, all messages matching the filters will be deleted.

Response

200 - application/json

All messages deleted successfully

cancelled

integer

Number of messages cancelled