Skip to main content
GET
/
v2
/
flowControl
/
{flowControlKey}
curl -X GET https://qstash.upstash.io/v2/flowControl/YOUR_FLOW_CONTROL_KEY  -H "Authorization: Bearer <token>"

{
  "flowControlKey": "YOUR_FLOW_CONTROL_KEY",
  "waitListSize": 5,
  "parallelismMax": 10,
  "parallelismCount": 3,
  "rateMax": 100,
  "rateCount": 42,
  "ratePeriod": 60,
  "ratePeriodStart": 1708000000
}

Documentation Index

Fetch the complete documentation index at: https://upstash-cloud-4245.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Request

​
flowControlKey
string
The key of the flow control. See the flow control for more details.

​
Response

​
flowControlKey
string
The key of the flow control.
​
waitListSize
integer
The number of messages in the wait list that waits for parallelism/rate set in the flow control.
​
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.
curl -X GET https://qstash.upstash.io/v2/flowControl/YOUR_FLOW_CONTROL_KEY  -H "Authorization: Bearer <token>"

{
  "flowControlKey": "YOUR_FLOW_CONTROL_KEY",
  "waitListSize": 5,
  "parallelismMax": 10,
  "parallelismCount": 3,
  "rateMax": 100,
  "rateCount": 42,
  "ratePeriod": 60,
  "ratePeriodStart": 1708000000
}