Queues

Pause Queue

Pause a queue to stop the delivery of enqueued messages

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

Authorization

Authorizationheaderstringrequired

Bearer authentication header of the form Bearer <token>.

Path parameters

queueNamepathstringrequired

The name of the queue to pause.

Response

200 — Queue paused successfully

400 — Queue name is invalid. Queue names can only contain alphanumeric characters, hyphens, periods, and underscores.

errorstringrequired

Error message

Loading search…