List DLQ messages - Upstash Documentation

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

topicName

string

Filter DLQ messages by URL Group name

scheduleId

string

Filter DLQ messages by schedule ID

queueName

string

Filter DLQ messages by queue name

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

callerIp

string

Filter DLQ messages by IP address of the publisher

label

string

Filter DLQ messages by the label of the message assigned by the user

count

integer

default:100

The number of messages to return.

Required range: x <= 100

order

enum<string>

default:latestFirst

The sorting order of DLQ messages by timestamp.

Available options:

latestFirst,

earliestFirst

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[]

Show child attributes

messages.messageId

string

Unique identifier for the message

messages.url

string

The URL to which the message should be delivered.

messages.topicName

string

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

messages.endpointName

string

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

messages.method

string

The HTTP method to use for the message.

messages.header

object

The HTTP headers sent to your API.

Show child attributes

messages.header.{key}

string[]

messages.body

string

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

messages.bodyBase64

string

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

messages.maxRetries

integer

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

messages.notBefore

integer<int64>

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

messages.createdAt

integer<int64>

The unix timestamp in milliseconds when the message was created.

messages.callback

string

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

messages.failureCallback

string

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

messages.queueName

string

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

messages.scheduleId

string

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

messages.callerIP

string

IP address of the publisher of this message.

messages.label

string

The label of the message assigned by the user.

messages.flowControlKey

string

The flow control key used for rate limiting.

messages.rate

integer

The rate value used for flow control.

messages.period

integer

The period value used for flow control.

messages.parallelism

integer

The parallelism value used for flow control.

messages.responseStatus

integer

The HTTP status code received from the destination API.

messages.responseHeader

object

The HTTP response headers received from the destination API.

Show child attributes

messages.responseHeader.{key}

string[]

messages.responseBody

string

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

messages.responseBodyBase64

string

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