Pause Flow Control Key

Pauses the delivery of messages associated with a specific flow-control key.

1 min read

post/v2/flowControl/{flowControlKey}/pause

Request example

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

Response

{
  "error": "<string>"
}

post/v2/flowControl/{flowControlKey}/pause

When a flow-control key is paused, messages associated with that key will not be delivered until the key is resumed.

Messages that are already in the waitlist will remain there. New incoming messages will be added directly to the waitlist.

While the key is paused, the current rate period continues to elapse and the existing rate count is preserved for that period.

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

flowControlKeystringrequired#

The flow-control key to pause.

The flow-control key has been paused.