Bulk Delete DLQ messages

Delete multiple messages from the DLQ

1 min read

delete/v2/dlq

Request example

curl --request DELETE \
  --url https://qstash-eu-central-1.upstash.io/v2/dlq?dlqIds=%3Cstring%3E&cursor=%3Cstring%3E&messageId=%3Cstring%3E&url=%3Cstring%3E&topicName=%3Cstring%3E&scheduleId=%3Cstring%3E&queueName=%3Cstring%3E&fromDate=1&toDate=1&responseStatus=1&callerIp=%3Cstring%3E&label=%3Cstring%3E&flowControlKey=%3Cstring%3E&count=100 \
  --header 'Authorization: Bearer <token>'

Response

{
  "cursor": "<string>",
  "deleted": 1
}

delete/v2/dlq

Info

For multi-value filters, a message matches if its value equals any of the given values (OR logic), and multiple filters are combined with AND logic.

Multiple values can be passed either by repeating the query parameter (label=label_1&label=label_2) or as a single comma-separated value (label=label_1,label_2).

Authorization

Authorizationstringheaderrequired#

QStash authentication token

1 alternative authorization method available — see the spec for details.

Query parameters

dlqIdsstring[]#

List of DLQ IDs to delete. If provided, other filters are ignored.

cursorstring#

By providing a cursor you can paginate through all of the messages in the DLQ

messageIdstring#

Filter DLQ messages by message ID

urlstring[]#

Filter DLQ messages by destination URL. Supports multiple values.

topicNamestring[]#

Filter DLQ messages by URL Group name. Supports multiple values.

scheduleIdstring[]#

Filter DLQ messages by schedule ID. Supports multiple values.

queueNamestring[]#

Filter DLQ messages by queue name. Supports multiple values.

fromDateinteger#

Filter DLQ messages by starting date, in milliseconds (Unix timestamp). This is inclusive.

toDateinteger#

Filter DLQ messages by ending date, in milliseconds (Unix timestamp). This is inclusive.

responseStatusinteger[]#

Filter DLQ messages by HTTP response status code of the last delivery attempt. Supports multiple values.

callerIpstring[]#

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

labelstring[]#

Filter DLQ 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 DLQ messages by Flow Control Key. Supports multiple values.

countinteger#

The number of messages to delete.

Default: 100

Range: <= 100

Responses

application/json

200

DLQ messages deleted successfully

cursorstring#

A cursor which you can use in subsequent requests to paginate through all messages.
If no cursor is returned, you have reached the end of the messages.

deletedinteger#

The number of messages that were deleted.

List DLQ messages Get a DLQ message