Get a Bulk Action

Retrieve the details and progress of a bulk action

1 min read

get/v2/workflows/bulkActions/{actionId}

Request example

curl --request GET \
  --url https://qstash-eu-central-1.upstash.io/v2/workflows/bulkActions/{actionId} \
  --header 'Authorization: Bearer <token>'

Response

{
  "actionId": "<string>",
  "kind": "cancel",
  "state": "IN_PROGRESS",
  "total": 1,
  "processed": 1,
  "createdAt": 1,
  "completedAt": 1,
  "filter": {
    "workflowUrl": [
      "https://example.com/api/workflow"
    ],
    "label": [
      "label_1",
      "label_2"
    ]
  }
}

get/v2/workflows/bulkActions/{actionId}

Authorization

Authorizationstringheaderrequired#

QStash authentication token

1 alternative authorization method available — see the spec for details.

Path parameters

actionIdstringrequired#

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

Responses

application/json

Bulk action details

actionIdstring#

The ID of the bulk action.

kindenum<string>#

The kind of the bulk action.

Options:cancel

stateenum<string>#

The state of the bulk action.

Value	Description
IN_PROGRESS	The bulk action is running in the background.
FINISHED	The bulk action has finished.

Options:IN_PROGRESSFINISHED

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.

Show child attributes

{key}string[]#

List Bulk Actions List Workflow Run Logs