List Flow-Control Keys

List All Flow Control Keys

GET https://qstash.upstash.io/v2/flowControl

curl -X GET https://qstash.upstash.io/v2/flowControl  -H "Authorization: Bearer <token>"

[
  {
    "flowControlKey": "my-key",
    "waitListSize": 5,
    "parallelismMax": 10,
    "parallelismCount": 3,
    "rateMax": 100,
    "rateCount": 42,
    "ratePeriod": 60,
    "ratePeriodStart": 1708000000
  }
]

Request

search · string

Optional search string to filter flow control keys by name.

Response

flowControls · Array

Show child attributes

flowControlKey · string

The key of the flow control. See the flow control for more details.

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  -H "Authorization: Bearer <token>"

[
  {
    "flowControlKey": "my-key",
    "waitListSize": 5,
    "parallelismMax": 10,
    "parallelismCount": 3,
    "rateMax": 100,
    "rateCount": 42,
    "ratePeriod": 60,
    "ratePeriodStart": 1708000000
  }
]