Get a Queue - Upstash Documentation

Get a Queue

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

{
  "name": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "parallelism": 123,
  "paused": true,
  "lag": 123
}

GET

queues

{queueName}

Get a Queue

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

{
  "name": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "parallelism": 123,
  "paused": true,
  "lag": 123
}

Authorization

string

header

required

QStash authentication token

queueName

string

required

The name of the queue to retrieve.

name

string

The name of the queue.

createdAt

integer<int64>

The creation timestamp of the queue in Unix milliseconds

updatedAt

integer<int64>

The last update timestamp of the queue in Unix milliseconds

parallelism

integer

The number of parallel consumers consuming from the queue

paused

boolean

Whether the queue is paused

lag

integer

The number of unprocessed messages that exist in the queue

⌘I

Documentation Index