Get a Queue

Get details of a specific queue

1 min read

get/v2/queues/{queueName}

Request example

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

Response

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

get/v2/queues/{queueName}

Authorization

Authorizationstringheaderrequired#

QStash authentication token

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

queueNamestringrequired#

The name of the queue to retrieve.

application/json

namestring#

The name of the queue.

createdAtinteger#

The creation timestamp of the queue in Unix milliseconds

updatedAtinteger#

The last update timestamp of the queue in Unix milliseconds

parallelisminteger#

The number of parallel consumers consuming from the queue

pausedboolean#

Whether the queue is paused

laginteger#

The number of unprocessed messages that exist in the queue