Get Flow Control Key

Get details of a specific Flow Control key

GET /v2/flowControl/{flowControlKey}

Get Flow Control Key

cURL

curl --request GET \
  --url https://qstash.upstash.io/v2/flowControl/{flowControlKey} \
  --header 'Authorization: Bearer <token>'

200

{
  "flowControlKey": "<string>",
  "waitListSize": 123,
  "parallelismMax": 123,
  "parallelismCount": 123,
  "rateMax": 123,
  "rateCount": 123,
  "ratePeriod": 123,
  "ratePeriodStart": 123
}

Authorizations

bearerAuthbearerAuthQuery

Authorization · string · header · required

QStash authentication token

Path Parameters

flowControlKey · string · required

The Flow Control key to retrieve

Response

200

application/json

Flow control key details

flowControlKey · string

The flow control key name

waitListSize · integer

The number of messages waiting due to flow control configuration.

parallelismMax · integer

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

parallelismCount · integer

The current number of messages running in parallel.

rateMax · integer

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

rateCount · integer

The number of messages dispatched in the current rate period.

ratePeriod · integer

The length of the rate period in seconds.

ratePeriodStart · integer

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