List Flow Control Keys

List all Flow Control keys

1 min read

get/v2/flowControl

Request example

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

Response

[
  {
    "flowControlKey": "<string>",
    "waitListSize": 1,
    "parallelismMax": 1,
    "parallelismCount": 1,
    "rateMax": 1,
    "rateCount": 1,
    "ratePeriod": 1,
    "ratePeriodStart": 1,
    "isPinnedParallelism": true,
    "isPinnedRate": true,
    "isPaused": true
  }
]

get/v2/flowControl

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

Responses

application/json

200

Flow control keys retrieved successfully

flowControlKeystring#

The flow control key name

waitListSizeinteger#

The number of messages waiting due to flow control configuration.

parallelismMaxinteger#

The configured maximum number of messages allowed to run concurrently, if parallelism is set.

parallelismCountinteger#

The current number of messages running in parallel.

rateMaxinteger#

The configured maximum number of messages allowed per rate period, if rate limiting is set.

rateCountinteger#

The number of messages dispatched in the current rate period.

ratePeriodinteger#

The length of the rate period in seconds.

ratePeriodStartinteger#

Unix timestamp (seconds) when the current rate period started.

isPinnedParallelismboolean#

True if the flow-control key has a pinned parallelism configuration.

isPinnedRateboolean#

True if the flow-control key has a pinned rate configuration.

isPausedboolean#

True if the delivery of messages associated with the flow-control key is paused.

Bulk Retry DLQ messages Get Flow Control Key