List DLQ messages - Upstash Documentation

GET/v2/dlq

cURL

curl --request GET \
  --url https://qstash-{region}.upstash.io/v2/dlq \
  --header 'Authorization: Bearer <token>'

200Response

{
  "cursor": "<string>",
  "messages": [
    {
      "messageId": "<string>",
      "url": "<string>",
      "topicName": "<string>",
      "endpointName": "<string>",
      "method": "<string>",
      "header": "<string>",
      "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": "<string>",
      "responseBody": "<string>",
      "responseBodyBase64": "<string>"
    }
  ]
}

Authorization

Authorizationheaderstringrequired

Bearer authentication header of the form Bearer <token>.

Query parameters

cursorquerystring

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

messageIdquerystring

Filter DLQ messages by message ID

urlquerystring[]

Filter DLQ messages by destination URL. Supports multiple values.

topicNamequerystring[]

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

scheduleIdquerystring[]

Filter DLQ messages by schedule ID. Supports multiple values.

queueNamequerystring[]

Filter DLQ messages by queue name. Supports multiple values.

fromDatequeryinteger

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

toDatequeryinteger

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

responseStatusqueryinteger[]

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

callerIpquerystring[]

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

labelquerystring[]

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

countqueryintegerdefault: 100

The number of messages to return.

Response

200 — List of DLQ messages

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.

messagesobject[]

messageIdstring

Unique identifier for the message

urlstring

The URL to which the message should be delivered.

topicNamestring

The URL Group (a.k.a. topic) name if this message was sent to a URL Group.

endpointNamestring

The endpoint name of the message if the endpoint is given a name within the URL group.

methodstring

The HTTP method to use for the message.

headerobject

The HTTP headers sent to your API.

bodystring

The body of the message if it is composed of utf8 chars only, empty otherwise.

bodyBase64string

The base64 encoded body if the body contains a non-utf8 char only, empty otherwise.

maxRetriesinteger

The number of retries that should be attempted in case of delivery failure.

notBeforeinteger

The unix timestamp in milliseconds before which the message should not be delivered.

createdAtinteger

The unix timestamp in milliseconds when the message was created.

callbackstring

The url where we send a callback each time the message is attempted to be delivered.

failureCallbackstring

The url where we send a callback to after the message is failed

queueNamestring

The name of the queue if the message is enqueued to a queue.

scheduleIdstring

The scheduleId of the message if the message is triggered by a schedule

callerIPstring

IP address of the publisher of this message.

labelstringdeprecated

The label of the message assigned by the user. Deprecated in favor of labels.

labelsstring[]

The list of labels assigned to the message by the user.

flowControlKeystring

The flow control key used for rate limiting.

rateinteger

The rate value used for flow control.

periodinteger

The period value used for flow control.

parallelisminteger

The parallelism value used for flow control.

responseStatusinteger

The HTTP status code received from the destination API.

responseHeaderobject

The HTTP response headers received from the destination API.

responseBodystring

The body of the response if it is composed of utf8 chars only, empty otherwise.

responseBodyBase64string

The base64 encoded body of the response if the body contains a non-utf8 char only, empty otherwise.