Skip to content

List queues

GET
/api/v1/storage/queues
curl --request GET \
--url https://digize.com/api/v1/storage/queues \
--header 'x-api-key: <x-api-key>'

The workspace’s queues with their producers, consumer, backlog, delivery state and the last day’s traffic.

Needs the sites:read permission.

Done

Media typeapplication/json
Array<object>
object
id
required
string
name
required
string
cloudflareName
required
string
createdAt
required
string format: date-time
deadLetterQueue
required
string | null
producers
required
Array<object>
object
worker
required
string
variable
required
string | null
consumer
required
Any of:
object
worker
required
string
bindingId
required
string
batchSize
required
number
maxWaitSeconds
required
number
maxRetries
required
number
maxConcurrency
required
number | null
set
required
boolean
deadLetterFor
required
string | null
backlog
required
number
perMinute
required
number
paused
required
boolean
hours
required
Array<object>
object
at
required
string format: date-time
published
required
number
delivered
required
number
failed
required
number
live
required
boolean

Example generated

[
{
"id": "example",
"name": "example",
"cloudflareName": "example",
"createdAt": "2026-04-15T12:00:00Z",
"deadLetterQueue": "example",
"producers": [
{
"worker": "example",
"variable": "example"
}
],
"consumer": {
"worker": "example",
"bindingId": "example",
"batchSize": 1,
"maxWaitSeconds": 1,
"maxRetries": 1,
"maxConcurrency": 1,
"set": true
},
"deadLetterFor": "example",
"backlog": 1,
"perMinute": 1,
"paused": true,
"hours": [
{
"at": "2026-04-15T12:00:00Z",
"published": 1,
"delivered": 1,
"failed": 1
}
],
"live": true
}
]

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}