UPupstash
Bulk Actions

Get a Bulk Action

Changed on

Retrieve the details and progress of a bulk action

get/v2/workflows/bulkActions/{actionId}

Request

Path parameters

actionIdstring required

The ID of the bulk action, as returned by a filter-based bulk cancel with async=true.

Response

Bulk action details

actionIdstring

The ID of the bulk action.

kind'cancel'

The kind of the bulk action.

state'IN_PROGRESS' | 'FINISHED'

The state of the bulk action.

ValueDescription
IN_PROGRESSThe bulk action is running in the background.
FINISHEDThe bulk action has finished.
totalinteger

The number of in-progress workflow runs that matched the filter when the bulk action was created.

processedinteger

The number of workflow runs processed by the bulk action so far.

createdAtinteger

The creation time of the bulk action, in milliseconds (Unix timestamp).

completedAtinteger

The completion time of the bulk action, in milliseconds (Unix timestamp). Only present once the bulk action has finished.

filterobject

The filter the bulk action was created with. Keys are the filter parameter names of the bulk cancel request, such as workflowUrl, label or fromDate, and values are the given values.

Example response

{
  "filter": {
    "workflowUrl": [
      "https://example.com/api/workflow"
    ],
    "label": [
      "label_1",
      "label_2"
    ]
  }
}

Changes