Get Flow Control Key

Get details of a specific Flow Control key

1 min read

get/v2/flowControl/{flowControlKey}

Request example

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

Response

{
  "flowControlKey": "<string>",
  "waitlistSize": 1
}

get/v2/flowControl/{flowControlKey}

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

flowControlKeystringrequired#

The Flow Control key to retrieve

application/json

Flow control key details

flowControlKeystring#

The flow control key name

waitlistSizeinteger#

The number of messages waiting due to flow control configuration.