List DLQ messages - Upstash Documentation

get/v2/dlq

Request example

curl --request GET \
  --url https://qstash-eu-central-1.upstash.io/v2/dlq \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://qstash-eu-central-1.upstash.io/v2/dlq"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://qstash-eu-central-1.upstash.io/v2/dlq', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://qstash-eu-central-1.upstash.io/v2/dlq',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://qstash-eu-central-1.upstash.io/v2/dlq"

	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://qstash-eu-central-1.upstash.io/v2/dlq"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://qstash-eu-central-1.upstash.io/v2/dlq')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Response

{
  "cursor": "<string>",
  "messages": [
    {
      "messageId": "<string>",
      "url": "<string>",
      "topicName": "<string>",
      "endpointName": "<string>",
      "method": "<string>",
      "header": {},
      "body": "<string>",
      "bodyBase64": "<string>",
      "maxRetries": 1,
      "notBefore": 1,
      "createdAt": 1,
      "callback": "<string>",
      "failureCallback": "<string>",
      "queueName": "<string>",
      "scheduleId": "<string>",
      "callerIP": "<string>",
      "label": "<string>",
      "labels": [
        "<string>"
      ],
      "flowControlKey": "<string>",
      "rate": 1,
      "period": 1,
      "parallelism": 1,
      "responseStatus": 1,
      "responseHeader": {},
      "responseBody": "<string>",
      "responseBodyBase64": "<string>"
    }
  ]
}

get/v2/dlq

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

Query parameters

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

countinteger#

The number of messages to return.

Default: 100

Range: <= 100

Responses

application/json

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

Show child attributes

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.

Show child attributes

{key}string[]#

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.

Show child attributes

{key}string[]#

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.

Remove Endpoints Get a DLQ message