Skip to main content
GET
/
v2
/
flowControl
/
{flowControlKey}
Get Flow Control Key
curl --request GET \
  --url https://qstash-{region}.upstash.io/v2/flowControl/{flowControlKey} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://qstash-{region}.upstash.io/v2/flowControl/{flowControlKey}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://qstash-{region}.upstash.io/v2/flowControl/{flowControlKey}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://qstash-{region}.upstash.io/v2/flowControl/{flowControlKey}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://qstash-{region}.upstash.io/v2/flowControl/{flowControlKey}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://qstash-{region}.upstash.io/v2/flowControl/{flowControlKey}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://qstash-{region}.upstash.io/v2/flowControl/{flowControlKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "flowControlKey": "<string>",
  "waitlistSize": 123
}
{
"error": "<string>"
}

Authorizations

Authorization
string
header
required

QStash authentication token

Path Parameters

flowControlKey
string
required

The Flow Control key to retrieve

Response

Flow control key details

flowControlKey
string

The flow control key name

waitlistSize
integer

The number of messages waiting due to flow control configuration.