Pause Flow Control Key

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

POST /v2/flowControl/{flowControlKey}/pause

Pause Flow Control Key

cURL

curl --request POST \
  --url https://qstash.upstash.io/v2/flowControl/{flowControlKey}/pause \
  --header 'Authorization: Bearer <token>'

400

{
  "error": "<string>"
}

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.

Authorizations

bearerAuthbearerAuthQuery

Authorization · string · header · required

QStash authentication token

Path Parameters

flowControlKey · string · required

The flow-control key to pause.

Response

200

The flow-control key has been paused.