Skip to main content
Bulk actions let you cancel or replay many runs asynchronously from the SDK by selecting runs with run IDs or SDK run-list filters. A bulk action returns a handle immediately. Use the handle to retrieve progress, poll until completion, list previous actions, or abort pending work.

Create a bulk replay

Use runs.bulk.replay() to replay every run that matches a filter.
Your backend code
filter accepts the SDK run-list filter fields, excluding pagination fields such as limit, after, and before. This is the TypeScript SDK shape used by runs.list() (from, to, and period are top-level fields), not the nested filter[createdAt] query shape shown in the raw HTTP list-runs endpoint. Provide at least one filter field; use runIds when you want to target specific runs. Relative time filters such as period are resolved when the bulk action is created, so later batches process the same fixed time range.
Filters inherit the same time semantics as runs.list(): when you don’t pass from, to, or period, the action defaults to the last 7 days and won’t target older matching runs. To cover a wider range, pass an explicit period (such as "30d"), a from timestamp, or a from/to pair. This default only applies to filter selections; runIds selections are never time-bounded.
filter
BulkActionFilter
Selects runs using the SDK run-list filter shape, excluding limit, after, and before. In raw HTTP requests these fields are sent as JSON body properties, so time fields are top-level (from, to, period) instead of nested under createdAt.
runIds
string[]
Selects specific run IDs. Provide either filter or runIds, not both.
name
string
A name for the bulk action.
targetRegion
string
Replays matching runs in a specific region. When omitted, each replay keeps the original run’s region. This option is only available for runs.bulk.replay().

Create a bulk cancel

Use runs.bulk.cancel() to cancel every run that matches a filter, or specific run IDs.
Your backend code
Only runs that are still cancelable when the action reaches them are canceled. Runs that have already reached a final state count as failures in the bulk action summary.

Retrieve progress

Use runs.bulk.retrieve() to read the current status and aggregate counts.
Your backend code
The returned bulk action object has these fields:
id
string
The bulk action ID, starting with bulk_.
type
'CANCEL' | 'REPLAY'
The action being performed.
status
'PENDING' | 'COMPLETED' | 'ABORTED'
The current bulk action status.
counts
object
Aggregate processing counts.
createdAt
Date
The date and time the bulk action was created.
completedAt
Date
The date and time the bulk action completed.

Poll for completion

Use runs.bulk.poll() to wait until the bulk action leaves the PENDING state.
Your backend code

Abort a bulk action

Use runs.bulk.abort() to stop future batches from being processed.
Your backend code
Abort is best effort. Runs already being processed in the current batch may still finish.
Each environment can only run a limited number of bulk replays at the same time. If you start a replay while too many are still in progress, the call fails and returns an error. Wait for an in-progress replay to finish or abort one before starting another. Bulk cancels are not subject to this limit.

List bulk actions

Use runs.bulk.list() to page through previous bulk actions in the current environment.
Your backend code
List results support the same auto-pagination helpers as other management API list methods:
Your backend code

API reference

The SDK methods use the bulk actions HTTP API: