Skip to main content
GET
/
v2
/
dlq
List DLQ messages
curl --request GET \
  --url https://qstash-{region}.upstash.io/v2/dlq \
  --header 'Authorization: Bearer <token>'
{
  "cursor": "<string>",
  "messages": [
    {
      "messageId": "<string>",
      "url": "<string>",
      "topicName": "<string>",
      "endpointName": "<string>",
      "method": "<string>",
      "header": {},
      "body": "<string>",
      "bodyBase64": "<string>",
      "maxRetries": 123,
      "notBefore": 123,
      "createdAt": 123,
      "callback": "<string>",
      "failureCallback": "<string>",
      "queueName": "<string>",
      "scheduleId": "<string>",
      "callerIP": "<string>",
      "label": "<string>",
      "labels": [
        "<string>"
      ],
      "flowControlKey": "<string>",
      "rate": 123,
      "period": 123,
      "parallelism": 123,
      "responseStatus": 123,
      "responseHeader": {},
      "responseBody": "<string>",
      "responseBodyBase64": "<string>"
    }
  ]
}
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).

Authorizations

​
Authorization
string
header
required

QStash authentication token

Query Parameters

​
cursor
string

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

​
messageId
string

Filter DLQ messages by message ID

​
url
string[]

Filter DLQ messages by destination URL. Supports multiple values.

​
topicName
string[]

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

​
scheduleId
string[]

Filter DLQ messages by schedule ID. Supports multiple values.

​
queueName
string[]

Filter DLQ messages by queue name. Supports multiple values.

​
fromDate
integer<int64>

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

​
toDate
integer<int64>

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

​
responseStatus
integer[]

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

​
callerIp
string[]

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

​
label
string[]

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
​
count
integer
default:100

The number of messages to return.

Required range: x <= 100

Response

200 - application/json

List of DLQ messages

​
cursor
string

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.

​
messages
object[]