The dlq.restart method restarts one or more workflow runs from Dead Letter Queue (DLQ) .
This allows you to reprocess workflow runs that previously failed after exhausting retries.
Arguments
The first argument specifies which DLQ entries to restart. The optional second argument provides flow control and retry settings.
By DLQ ID
Pass a single DLQ ID or an array of IDs directly:
await client . dlq . restart ( "dlq-12345" );
await client . dlq . restart ([ "dlq-12345" , "dlq-67890" ]);
By filters
Pass an object with a filter field:
Filter by exact workflow URL.
Filter by workflow run ID.
Restart workflows with this label. Pass an array to match runs that
have any of the given labels (OR semantics).
Restart workflows created after this date.
Restart workflows created before this date.
Filter by the IP address that triggered the workflow.
Filter by flow control key.
Filter by workflow creation time (Unix timestamp in ms).
Filter by failure callback state.
Maximum number of messages to process per call. Defaults to 100.
A pagination cursor from a previous request.
Restart all
Set to true to restart all DLQ entries.
Options (second argument)
An optional flow control configuration to limit concurrency and execution rate of restarted workflow runs. See Flow Control for details. A logical grouping key that identifies which requests share the same flow control limits.
The maximum number of allowed requests per second.
The maximum number of concurrent requests allowed.
The time window used to enforce the defined rate limit. Default is 1s.
Number of retry attempts to apply to the restarted workflow invocation.
Defaults to 3 if not provided.
Response
A pagination cursor. If not returned, all matching entries have been processed.
The ID of the new workflow run created from the restarted DLQ message.
The Unix timestamp (in milliseconds) when the new workflow run was created.
Usage
Single
Multiple
By filters
All
const { messages } = await client . dlq . list ();
const response = await client . dlq . restart ( messages [ 0 ]. dlqId , {
flowControl: {
key: "my-flow-control-key" ,
parallelism: 10 ,
},
retries: 3 ,
});