Skip to main content
DELETE
Bulk Cancel Workflow Runs

Authorizations

Authorization
string
header
required

QStash authentication token

Query Parameters

workflowRunIds
string[]

Optional list of specific workflow run IDs to cancel. If provided, the other filters are ignored.

workflowUrl
string[]
required

The URL of the workflow whose runs to cancel. Supports multiple values.

workflowUrlExactMatch
boolean
default:false

workflow url is searched as a prefix by default. To make it exact match, workflowUrlExactMatch can be set to true.

fromDate
number<date-time>

Optional start date to filter workflow runs to cancel. Unix timestamp in milliseconds.

toDate
number<date-time>

Optional end date to filter workflow runs to cancel. Unix timestamp in milliseconds.

callerIp
string[]

Optional caller IP address to filter workflow runs to cancel. Supports multiple values.

flowControlKey
string[]

Optional flow control key to filter workflow runs to cancel. Supports multiple values.

label
string[]

Optional label to filter workflow runs to cancel. Supports multiple values. You can pass multiple values to match workflow runs with any of the given labels (OR logic).

Examples:

  • label=my_label
  • label=label_1&label=label_2
  • label=label_1,label_2
count
integer
default:100

Maximum number of workflow runs to cancel. Default is 100.

Response

200 - application/json

All workflow runs cancelled successfully

cancelled
integer

The number of workflow runs that were cancelled.