Get Flow Control Key

Get details of a specific Flow Control key.

Flow Control keys are used to manage concurrency and rate limiting for workflow steps. This endpoint returns the current waitlist size for the specified flow control key, which indicates how many workflow steps are currently waiting due to flow control constraints.

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
}

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.