client.dlq.delete - Upstash Documentation

The dlq.delete method deletes one or more workflow runs from the Dead Letter Queue (DLQ).

Arguments

You can delete DLQ entries by ID, by an array of IDs, or by filters.

By DLQ ID

Pass a single DLQ ID or an array of IDs directly:

await client.dlq.delete("dlq-123");
await client.dlq.delete(["dlq-123", "dlq-456"]);

Or as an object with dlqIds:

await client.dlq.delete({ dlqIds: ["dlq-123", "dlq-456"] });

By filters

filter

object

Hide child attributes

workflowUrl

string

Filter by exact workflow URL.

workflowRunId

string

Filter by workflow run ID.

label

string

Delete workflows with this label.

fromDate

Date | number

Delete workflows created after this date. Accepts Date objects or Unix timestamps (ms).

toDate

Date | number

Delete workflows created before this date. Accepts Date objects or Unix timestamps (ms).

callerIp

string

Filter by the IP address that triggered the workflow.

flowControlKey

string

Filter by flow control key.

workflowCreatedAt

number

Filter by workflow creation time (Unix timestamp in ms).

failureFunctionState

string

Filter by failure callback state.

count

number

Maximum number of messages to process per call. Defaults to 100.

cursor

string

A pagination cursor from a previous request.

Delete all

all

boolean

Set to true to delete all DLQ entries.

Response

deleted

number

The number of DLQ entries that were deleted.

cursor

string

A pagination cursor. If not returned, all matching entries have been processed.

Usage

await client.dlq.delete("dlq-123");

Workflow

Documentation Index

​Arguments

​By DLQ ID

​By filters

​Delete all

​Response

​Usage

Arguments

By DLQ ID

By filters

Delete all

Response

Usage