Upsert a Queue

Updates or creates a queue

1 min read

post/v2/queues

Request example

curl --request POST \
  --url https://qstash-eu-central-1.upstash.io/v2/queues \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "queueName": "<string>",
  "parallelism": 1
}'

Response

{
  "error": "<string>"
}

post/v2/queues

Warning

For rate-limiting use cases, we've introduced a more performant and less restrictive Flow Control feature for the Publish API.

We are planning to deprecate setting parallelism greater than 1 for the Queue API in future. If you're currently using Queue API with parallelism greater than 1 for rate limiting, consider using Flow Control.

Queues with parallelism set to 1 provide FIFO guarantees, which remains a valid use case for the Queue API.

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

Body

application/json

queueNamestringrequired#

The name of the queue

parallelismintegerrequired#

The number of parallel consumers consuming from the queue. Must be greater than 0.

Default: 1

Range: >= 1

Responses

Queue created or updated successfully

List Queues Get a Queue