List Bulk Actions

List the bulk actions created by filter-based message cancels

1 min read

get/v2/bulkActions

Request example

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

Response

{
  "bulkActions": [
    {
      "actionId": "<string>",
      "kind": "cancel",
      "state": "IN_PROGRESS",
      "total": 1,
      "processed": 1,
      "createdAt": 1,
      "completedAt": 1,
      "filter": {
        "queueName": [
          "my-queue"
        ],
        "label": [
          "label_1",
          "label_2"
        ]
      }
    }
  ],
  "cursor": "<string>"
}

get/v2/bulkActions

A bulk action is created for every filter-based bulk cancel request, and tracks the progress of the cancellation running in the background.

Bulk actions are kept for 7 days after they are created.

Note

The state filter is applied to each page separately. A page may contain fewer than count bulk actions, or none at all, even when there are more to list. Keep paginating until no cursor is returned.

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

Query parameters

cursorstring#

By providing a cursor you can paginate through all of the bulk actions.

countinteger#

The number of bulk actions to scan per page. Values above 1000 are treated as 1000.

Default: 100

Range: 1–1000

stateenum<string>#

Filter bulk actions by state.

Options:IN_PROGRESSFINISHED

Responses

application/json

List of bulk actions

bulkActionsobject[]#

Show child attributes

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 messages that matched the filter when the bulk action was created.

processedinteger#

The number of messages 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 queueName, label or fromDate, and values are the given values.

Show child attributes

{key}string[]#

cursorstring#

A cursor which you can use in subsequent requests to paginate through all bulk actions.
If no cursor is returned, you have reached the end of the bulk actions.

Bulk Cancel Messages Get a Bulk Action