UPupstash
DLQ

Bulk Restart Workflows from DLQ

Changed on

Restart multiple failed workflow runs from the DLQ. Each workflow will start from the beginning.

Unlike resume, which continues from where workflows failed, restart executes the entire workflows from the first step. New workflow run IDs are generated and all steps will be executed again.

A maximum of 50 workflow runs can be restarted per request. If more runs are available, a cursor is returned, which can be used in subsequent requests to continue the operation. When no cursor is returned, all entries have been processed. Each restarted workflow run is assigned a new random Run ID.

post/v2/workflows/dlq/restart

Request

Query parameters

dlqIdsstring[]

List of specific DLQ IDs to restart. If provided, other filters are ignored.

cursorstring

Pagination cursor for restarting workflows in batches.

countinteger

Maximum number of workflows to restart. If not provided, all matching workflows will be restarted.

fromDateinteger

Filter workflows by starting date, in milliseconds (Unix timestamp). This is inclusive.

toDateinteger

Filter workflows by ending date, in milliseconds (Unix timestamp). This is inclusive.

workflowUrlstring[]

Filter workflows by workflow URL. Supports multiple values.

workflowRunIdstring

Filter workflows by workflow run ID.

workflowCreatedAtinteger

Filter workflows by creation timestamp in milliseconds (Unix timestamp).

labelstring[]

Filter workflows by label. Supports multiple values. You can pass multiple values to match workflows with any of the given labels (OR logic).

Examples:

  • label=my_label
  • label=label_1&label=label_2
  • label=label_1,label_2
failureFunctionStatestring[]

Filter workflows by failure function state. Supports multiple values.

StateDescription
CALLBACK_INPROGRESSThe failure function is in progress.
CALLBACK_SUCCESSThe failure function run successfully.
CALLBACK_FAILThe failure function failed to run.
CALLBACK_CANCELEDThe failure function was manually canceled
callerIpstring[]

Filter workflows by IP address of the publisher. Supports multiple values.

flowControlKeystring[]

Filter workflows by Flow Control Key. Supports multiple values.

Headers

Upstash-Retriesinteger

Override the number of retries for the workflow steps.

Upstash-Delaystring

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

Upstash-Retry-Delaystring

Override the retry delay expression for the workflow steps.

Upstash-Flow-Control-Keystring

Override the flow control key for the workflows.

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 workflows.

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 workflows.

Response

Workflows restarted successfully

cursorstring

Pagination cursor to use in subsequent requests. If empty, all matching workflows have been processed.

Changes

  • 4fcd7653bd06Revision changes
    • info

      for the query request parameter callerIp, the type was generalized from string to array

    • info

      for the query request parameter failureFunctionState, the type was generalized from string to array

    • info

      for the query request parameter flowControlKey, the type was generalized from string to array

    • info

      for the query request parameter workflowUrl, the type was generalized from string to array

  • 4cbcb5c2eac1Revision changes
    • info

      for the query request parameter label, the type was generalized from string to array