Async Bulk - Upstash Documentation

post/v2/dlq/bulkRetry

Request example

curl --request POST \
  --url https://qstash-eu-central-1.upstash.io/v2/dlq/bulkRetry \
  --header 'Authorization: Bearer <token>' \
  --header 'Upstash-Method: GET' \
  --header 'Upstash-Timeout: <string>' \
  --header 'Upstash-Retries: 1' \
  --header 'Upstash-Retry-Delay: <string>' \
  --header 'Upstash-Delay: <string>' \
  --header 'Upstash-Not-Before: 1' \
  --header 'Upstash-Label: <string>' \
  --header 'Upstash-Flow-Control-Key: <string>' \
  --header 'Upstash-Flow-Control-Value: <string>' \
  --header 'Upstash-Callback: <string>' \
  --header 'Upstash-Failure-Callback: <string>'

import requests

url = "https://qstash-eu-central-1.upstash.io/v2/dlq/bulkRetry"
headers = {
    "Authorization": "Bearer <token>",
    "Upstash-Method": "GET",
    "Upstash-Timeout": "<string>",
    "Upstash-Retries": "1",
    "Upstash-Retry-Delay": "<string>",
    "Upstash-Delay": "<string>",
    "Upstash-Not-Before": "1",
    "Upstash-Label": "<string>",
    "Upstash-Flow-Control-Key": "<string>",
    "Upstash-Flow-Control-Value": "<string>",
    "Upstash-Callback": "<string>",
    "Upstash-Failure-Callback": "<string>",
}

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

print(response.text)

const response = await fetch('https://qstash-eu-central-1.upstash.io/v2/dlq/bulkRetry', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Upstash-Method': 'GET',
    'Upstash-Timeout': '<string>',
    'Upstash-Retries': '1',
    'Upstash-Retry-Delay': '<string>',
    'Upstash-Delay': '<string>',
    'Upstash-Not-Before': '1',
    'Upstash-Label': '<string>',
    'Upstash-Flow-Control-Key': '<string>',
    'Upstash-Flow-Control-Value': '<string>',
    'Upstash-Callback': '<string>',
    'Upstash-Failure-Callback': '<string>'
  }
});

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/bulkRetry',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
    'Upstash-Method: GET',
    'Upstash-Timeout: <string>',
    'Upstash-Retries: 1',
    'Upstash-Retry-Delay: <string>',
    'Upstash-Delay: <string>',
    'Upstash-Not-Before: 1',
    'Upstash-Label: <string>',
    'Upstash-Flow-Control-Key: <string>',
    'Upstash-Flow-Control-Value: <string>',
    'Upstash-Callback: <string>',
    'Upstash-Failure-Callback: <string>',
  ],
]);

$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/bulkRetry"

	req, _ := http.NewRequest("POST", url, nil)
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Upstash-Method", "GET")
	req.Header.Add("Upstash-Timeout", "<string>")
	req.Header.Add("Upstash-Retries", "1")
	req.Header.Add("Upstash-Retry-Delay", "<string>")
	req.Header.Add("Upstash-Delay", "<string>")
	req.Header.Add("Upstash-Not-Before", "1")
	req.Header.Add("Upstash-Label", "<string>")
	req.Header.Add("Upstash-Flow-Control-Key", "<string>")
	req.Header.Add("Upstash-Flow-Control-Value", "<string>")
	req.Header.Add("Upstash-Callback", "<string>")
	req.Header.Add("Upstash-Failure-Callback", "<string>")

	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/bulkRetry"))
    .header("Authorization", "Bearer <token>")
    .header("Upstash-Method", "GET")
    .header("Upstash-Timeout", "<string>")
    .header("Upstash-Retries", "1")
    .header("Upstash-Retry-Delay", "<string>")
    .header("Upstash-Delay", "<string>")
    .header("Upstash-Not-Before", "1")
    .header("Upstash-Label", "<string>")
    .header("Upstash-Flow-Control-Key", "<string>")
    .header("Upstash-Flow-Control-Value", "<string>")
    .header("Upstash-Callback", "<string>")
    .header("Upstash-Failure-Callback", "<string>")
    .method("POST", 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/bulkRetry')

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

request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Upstash-Method'] = 'GET'
request['Upstash-Timeout'] = '<string>'
request['Upstash-Retries'] = '1'
request['Upstash-Retry-Delay'] = '<string>'
request['Upstash-Delay'] = '<string>'
request['Upstash-Not-Before'] = '1'
request['Upstash-Label'] = '<string>'
request['Upstash-Flow-Control-Key'] = '<string>'
request['Upstash-Flow-Control-Value'] = '<string>'
request['Upstash-Callback'] = '<string>'
request['Upstash-Failure-Callback'] = '<string>'

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

Response

{
  "actionId": "action_...",
  "total": 42
}

{
  "error": "<string>"
}

post/v2/dlq/bulkRetry

Each retry creates a new message with the original body and headers, then removes the original DLQ entry.

The request returns after creating the action. Use its actionId with Get a Bulk Action to check progress.

Identical filters submitted while an action is already in-progress return the existing action.

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

Query parameters

messageIdstring#

Filter by message ID.

urlstring[]#

Filter by destination URL. Supports multiple values.

topicNamestring[]#

Filter by URL Group name. Supports multiple values.

scheduleIdstring[]#

Filter by schedule ID. Supports multiple values.

queueNamestring[]#

Filter by queue name. Supports multiple values.

responseStatusinteger[]#

Filter by the last delivery attempt's HTTP response status. Supports multiple values.

fromDateinteger#

Inclusive start of the DLQ date range, in Unix milliseconds.

toDateinteger#

Inclusive end of the DLQ date range, in Unix milliseconds.

callerIpstring[]#

Filter by publisher IP address. Supports multiple values.

labelstring[]#

Filter by message label. Supports multiple values.

flowControlKeystring[]#

Filter by flow control key. Supports multiple values.

Headers

Upstash-Methodenum<string>#

Override the HTTP method used to deliver each retried message.

Options:GETPOSTPUTPATCHDELETE

Upstash-Timeoutstring#

Override the delivery timeout for each retried message, such as 30s or 2m.

Upstash-Retriesinteger#

Override the number of delivery retries for each retried message. Use 0 to disable retries.

Upstash-Retry-Delaystring#

Override the retry delay expression for each retried message.

Upstash-Delaystring#

Delay each retried message's delivery. Format is <value><unit>, such as 10s or 5m.

Upstash-Not-Beforeinteger#

Delay delivery until this Unix timestamp in seconds. Takes precedence over Upstash-Delay.

Upstash-Labelstring#

Override the labels on each retried message. Use a comma-separated list for multiple labels.

Upstash-Flow-Control-Keystring#

Override the flow control key for each retried message. Set Upstash-Flow-Control-Value to define its limits.

Upstash-Flow-Control-Valuestring#

Override the flow control limits in the format parallelism=<value>, rate=<value>, period=<value>.

Upstash-Callbackstring#

Override the success or failure callback URL for each retried message.

Upstash-Failure-Callbackstring#

Override the failure callback URL for each retried message.

Responses

application/json

The background action was created or an identical in-progress action was returned.

actionIdstringrequired#

ID used to check the background action's progress.

totalintegerrequired#

Number of DLQ messages matching the filters when the action was created.

Multiple IDs Sync Bulk