Resume Workflow from DLQ

1 min read

post/v2/workflows/dlq/resume/{dlqId}

Request example

curl --request POST \
  --url https://qstash-eu-central-1.upstash.io/v2/workflows/dlq/resume/%3Cstring%3E \
  --header 'Authorization: Bearer <token>' \
  --header 'Upstash-Retries: 1' \
  --header 'Upstash-Delay: <string>' \
  --header 'Upstash-Retry-Delay: <string>' \
  --header 'Upstash-Flow-Control-Key: <string>' \
  --header 'Upstash-Flow-Control-Value: <string>' \
  --header 'Upstash-Label: <string>' \
  --header 'Upstash-Failure-Callback: <string>'

Response

{
  "workflowRunId": "<string>",
  "workflowCreatedAt": 1
}

post/v2/workflows/dlq/resume/{dlqId}

When a workflow run fails, it's automatically moved to the DLQ (Dead Letter Queue) where it can be analyzed and resumed. The resume feature allows you to continue a failed workflow run from exactly where it failed, without re-executing successfully completed steps.

This is particularly useful for long-running workflows where you don't want to lose progress from successful steps when a single step fails.

When a workflow is resumed, it continues execution from the last failed step. A new workflow run ID is generated, but the workflow maintains the state and results from previously completed steps.

Note

You can make changes to the workflow code as long as these changes come after the failed steps. However, making changes before the failed step will break the code and is not allowed.

For more details, check out Handle workflow route code changes page.

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

Path parameters

dlqIdstringrequired#

The DLQ ID of the workflow run to resume.

Headers

Upstash-Retriesinteger#

Override the number of retries for the remaining workflow steps.

Upstash-Delaystring#

Override the delay before executing the next workflow step. Format is <value><unit> (e.g., "10s", "5m").

Upstash-Retry-Delaystring#

Override the retry delay expression for the remaining workflow steps.

Upstash-Flow-Control-Keystring#

Override the flow control key for the remaining workflow steps.

Upstash-Flow-Control-Valuestring#

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

Upstash-Labelstring#

Override the label(s) for the remaining workflow steps.

You can assign multiple labels by providing a comma-separated list.

Example: label_1,label_2

Upstash-Failure-Callbackstring#

Override the failure callback URL for the remaining workflow steps.

Responses

application/json

Workflow resumed successfully

workflowRunIdstring#

The ID of the resumed workflow run (a new ID is generated for the resumed run).

workflowCreatedAtinteger#

The timestamp when the resumed workflow run was created (Unix timestamp in milliseconds).

Delete Failed Workflow Run Bulk Resume Workflows from DLQ