List messages in the DLQ

List and paginate through all messages currently inside the DLQ

GET /v2/dlq

Request

curl https://qstash.upstash.io/v2/dlq \
  -H "Authorization: Bearer <token>"

curl https://qstash.upstash.io/v2/dlq?cursor=xxx \
  -H "Authorization: Bearer <token>"

200 OK

{ 
  "messages": [
    {
      "messageId": "msg_123",
      "topicId": "tpc_123",
      "url":"https://example.com",
      "method": "POST",
      "header": {
        "My-Header": ["my-value"]
      },
      "body": "{\"foo\":\"bar\"}",
      "createdAt": 1620000000000,
      "state": "failed"
    }
  ]
}

List all messages currently inside the DLQ

Request

cursor · string

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

Response

cursor · string

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

messages · Array

Hide message

messageId · string · required

A unique identifier for this message.

topicName · string

The topic name if this message was sent to a topic.

endpointName · string

The endpointName of the message if the endpoint is given a name withing the topic.

url · string · required

The URL to which the message should be delivered.

method · string

The HTTP method to use for the message.

header · Record<string, string[]>

The HTTP headers sent to your API.

body · string

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

bodyBase64 · string

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

maxRetries · int

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

notBefore · int

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

createdAt · int · required

The unix timestamp in milliseconds when the message was created.

callback · string

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

failureCallback · string

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

dlqId · string · required

The unique id within the DLQ. Use this to remove the message from the DLQ DELETE /v2/dlq/{dlqId}

responseStatus · int

The http status code of the last failed deliver attempt.

responseHeader · string

The response header of the last failed deliver attempt.

responseBody · string

The response body of the last failed deliver attempt.

responseBody · string

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

responseBodyBase64 · string

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

Request

curl https://qstash.upstash.io/v2/dlq \
  -H "Authorization: Bearer <token>"

curl https://qstash.upstash.io/v2/dlq?cursor=xxx \
  -H "Authorization: Bearer <token>"

200 OK

{ 
  "messages": [
    {
      "messageId": "msg_123",
      "topicId": "tpc_123",
      "url":"https://example.com",
      "method": "POST",
      "header": {
        "My-Header": ["my-value"]
      },
      "body": "{\"foo\":\"bar\"}",
      "createdAt": 1620000000000,
      "state": "failed"
    }
  ]
}