Pause Queue

Pause a queue to stop the delivery of enqueued messages

1 min read

post/v2/queues/{queueName}/pause

Request example

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

Response

{
  "error": "<string>"
}

post/v2/queues/{queueName}/pause

Pausing a queue stops the delivery of enqueued messages. The queue continues to accept new messages, but they will not be delivered until the queue is resumed.

If the queue is already paused, this action has no effect.

Warning

Resuming or creating a queue may take up to a minute. Therefore, it is not recommended to pause or delete a queue during critical operations.

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

Path parameters

queueNamestringrequired#

The name of the queue to pause.

Responses

Queue paused successfully

Delete a queue Resume Queue