client.dlq.delete

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

object

Hide child attributes

string

Filter by exact workflow URL.

string

Filter by workflow run ID.

string | string[]

Delete workflows with this label. Pass an array to match runs that have any of the given labels (OR semantics).

Date | number

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

Date | number

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

string

Filter by the IP address that triggered the workflow.

string

Filter by flow control key.

number

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

string

Filter by failure callback state.

number

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

string

A pagination cursor from a previous request.

Delete all

boolean

Set to true to delete all DLQ entries.

Response

number

The number of DLQ entries that were deleted.

string

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

Usage

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

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

// delete by label
let cursor: string | undefined;
do {
  const result = await client.dlq.delete({
    filter: { label: "my-label" },
    cursor,
  });
  cursor = result.cursor;
} while (cursor);

let cursor: string | undefined;
do {
  const result = await client.dlq.delete({ all: true, cursor });
  cursor = result.cursor;
} while (cursor);

Getting Started

Core Concepts

Features

Agents

API Reference

Resources

Arguments

By DLQ ID

By filters

Delete all

Response

Usage

​Arguments

​By DLQ ID

​By filters

​Delete all

​Response

​Usage

Arguments

By DLQ ID

By filters

Delete all

Response

Usage