Skip to main content
POST
/
v2
/
flowControl
/
{flowControlKey}
/
unpin
Unpin Configuration for Flow Control Key
curl --request POST \
  --url https://qstash-{region}.upstash.io/v2/flowControl/{flowControlKey}/unpin \
  --header 'Authorization: Bearer <token>'
{
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://upstash.com/docs/llms.txt

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

Normally, each message sent to QStash includes a flow-control configuration for the corresponding flow-control key, and the processing configuration is updated according to incoming messages. When a configuration is pinned, the system ignores configurations provided by incoming messages and continues using the pinned configuration. Calling this endpoint removes the pinned configuration. After unpinning, the system resumes the default behavior and updates the configuration based on configurations provided by incoming messages. Message delivery will initially continue using the last pinned configuration. Once a new message with a different configuration is received, the system updates the configuration accordingly. Use this API when you want to return to the default flow-control behavior after temporarily pinning a configuration.

Authorizations

​
Authorization
string
header
required

QStash authentication token

Path Parameters

​
flowControlKey
string
required

The flow-control key for which the configuration will be unpinned.

Query Parameters

​
parallelism
boolean
default:false

The flag to indicate whether to unpin the parallelism configuration.

​
rate
boolean
default:false

The flag to indicate whether to unpin the rate configuration.

Response

The flow-control key configuration is pinned