Unpin Configuration for Flow Control Key

Removes the pinned configuration for a specific flow-control key.

1 min read

post/v2/flowControl/{flowControlKey}/unpin

Request example

curl --request POST \
  --url https://qstash-eu-central-1.upstash.io/v2/flowControl/%3Cstring%3E/unpin?parallelism=false&rate=false \
  --header 'Authorization: Bearer <token>'

Response

{
  "error": "<string>"
}

post/v2/flowControl/{flowControlKey}/unpin

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.

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

Path parameters

flowControlKeystringrequired#

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

Query parameters

parallelismboolean#

The flag to indicate whether to unpin the parallelism configuration.

Default: false

rateboolean#

The flag to indicate whether to unpin the rate configuration.

Default: false

Responses

The flow-control key configuration is pinned

Pin Configuration for Flow Control Key Reset Rate for Flow Control Key